1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

doc/porting-boards: fix broken links

This commit is contained in:
Gunar Schorcht 2020-03-04 13:28:23 +01:00
parent a19157ad9b
commit 2d0ee5ca67

View File

@ -150,7 +150,7 @@ The documentation must be under the proper doxygen group, you can compile the
documentation by calling `make doc` and then open the generated html file on
any browser.
```md
@code
/**
@defgroup boards_foo FooBoard
@ingroup boards
@ -170,7 +170,7 @@ any browser.
...
*/
```
@endcode
# Using Common code {#common-board-code}
@ -183,7 +183,7 @@ already defined in the common code. Unless having specific configurations or
initialization you might not need a `board.c` or `board.h`. Another common use
case is common peripheral configurations:
```diff
@code
-\#include "cfg_timer_tim5.h"
+/**
+ * @name Timer configuration
@ -203,7 +203,7 @@ case is common peripheral configurations:
+
+#define TIMER_NUMOF ARRAY_SIZE(timer_config)
+/** @} */
```
@endcode
If you want to use common makefiles, include them at the end of the specific
`Makefile`, e.g. for a `Makefile.features`:
@ -281,7 +281,7 @@ In this case some special considerations must be taken with the makefiles:
`include $(RIOTBOARD)/foo-parent/Makefile.*include*`
An example can be found in
[`tests/external_board_native`](https://github.com/RIOT-OS/RIOT/tree/master/tests/external_board_native`)
[`tests/external_board_native`](https://github.com/RIOT-OS/RIOT/tree/master/tests/external_board_native)
# Tools {#boards-tools}