riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc/porting-boards: fix broken links

Browse Source
This commit is contained in:
Gunar Schorcht 2020-03-04 13:28:23 +01:00
parent a19157ad9b
commit 2d0ee5ca67
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/doxygen/src/porting-boards.md
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 documentation by calling `make doc` and then open the generated html file on
any browser. any browser.
```md @code
/** /**
@defgroup boards_foo FooBoard @defgroup boards_foo FooBoard
@ingroup boards @ingroup boards
@ -170,7 +170,7 @@ any browser.
... ...
*/ */
``` @endcode
# Using Common code {#common-board-code} # 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 initialization you might not need a `board.c` or `board.h`. Another common use
case is common peripheral configurations: case is common peripheral configurations:
```diff @code
-\#include "cfg_timer_tim5.h" -\#include "cfg_timer_tim5.h"
+/** +/**
+ * @name Timer configuration + * @name Timer configuration
@ -203,7 +203,7 @@ case is common peripheral configurations:
+ +
+#define TIMER_NUMOF ARRAY_SIZE(timer_config) +#define TIMER_NUMOF ARRAY_SIZE(timer_config)
+/** @} */ +/** @} */
``` @endcode
If you want to use common makefiles, include them at the end of the specific If you want to use common makefiles, include them at the end of the specific
`Makefile`, e.g. for a `Makefile.features`: `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*` `include $(RIOTBOARD)/foo-parent/Makefile.*include*`
An example can be found in 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} # Tools {#boards-tools}