@@ -191,9 +191,51 @@ PORT_DARWIN ?= $(firstword $(sort $(wildcard /dev/tty.usbserial*)))
191191PROGRAMMER ?= openocd
192192```
193193
194- ### Timer Configurations
194+ ### doc.md
195+
196+ Although not explicitly needed, if upstreamed and as a general good
197+ practice, this file holds all ` BOARD ` documentation. This can include
198+ datasheet reference, documentation on how to flash, etc.
199+
200+ The documentation must be under the proper doxygen group, you can compile the
201+ documentation by calling ` make doc ` and then open the generated html file on
202+ any browser.
203+
204+ ``` markdown
205+ @defgroup boards_foo FooBoard
206+ @ingroup boards
207+ @brief Support for the foo board
208+ @author FooName BarName <
[email protected] >
209+
210+ #### User Interface
211+
212+ ...
213+
214+ #### Using UART
215+
216+ ...
217+
218+ #### Flashing the device
219+
220+ ...
221+ ```
222+
223+ Previously documentation was contained in ` doc.txt ` files with C-style comment
224+ blocks. This style has been deprecated in favor of using ` doc.md ` files in
225+ Markdown format, which eliminates formatting and interpretation issues.
226+ Old style files will continually be replaced by the new format.
227+
228+ Up to version ` 0.9.2 ` the [ riotgen] ( https://pypi.org/project/riotgen/ ) tool
229+ will generate ` doc.txt ` files instead of ` doc.md ` files. You can upgrade it to
230+ the latest version with
231+
232+ ``` bash
233+ pip install --upgrade riotgen
234+ ```
235+
236+ ## Timer Configuration
195237
196- #### Timer Width
238+ ### Timer Width
197239
198240Some resource constrained or low-power microcontrollers only have 16-bit
199241wide timer registers available. By default ` ztimer ` assumes a timer width of
@@ -221,7 +263,7 @@ For example: If you observe "erratic" blinking patterns in
221263`examples/basic/blinky`, make sure to check if the sizes match.
222264:::
223265
224- #### Overhead Calibration
266+ ### Overhead Calibration
225267
226268When using the high level timer `ztimer` there is an overhead in calling the
227269[ztimer_sleep](https://doc.riot-os.org/group__sys__ztimer.html#gade98636e198f2d571c8acd861d29d360)
@@ -266,48 +308,6 @@ Alternatively, the pseudomodule
266308can be used in an application to enable automatic timer offset compensation at board startup.
267309This however incurs overhead both in the text segment and at bootup time.
268310
269- ### doc.md
270-
271- Although not explicitly needed, if upstreamed and as a general good
272- practice, this file holds all ` BOARD ` documentation. This can include
273- datasheet reference, documentation on how to flash, etc.
274-
275- The documentation must be under the proper doxygen group, you can compile the
276- documentation by calling ` make doc ` and then open the generated html file on
277- any browser.
278-
279- ``` markdown
280- @defgroup boards_foo FooBoard
281- @ingroup boards
282- @brief Support for the foo board
283- @author FooName BarName <
[email protected] >
284-
285- #### User Interface
286-
287- ...
288-
289- #### Using UART
290-
291- ...
292-
293- #### Flashing the device
294-
295- ...
296- ```
297-
298- Previously documentation was contained in ` doc.txt ` files with C-style comment
299- blocks. This style has been deprecated in favor of using ` doc.md ` files in
300- Markdown format, which eliminates formatting and interpretation issues.
301- Old style files will continually be replaced by the new format.
302-
303- Up to version ` 0.9.2 ` the [ riotgen] ( https://pypi.org/project/riotgen/ ) tool
304- will generate ` doc.txt ` files instead of ` doc.md ` files. You can upgrade it to
305- the latest version with
306-
307- ``` bash
308- pip install --upgrade riotgen
309- ```
310-
311311## Helper Tools
312312
313313To help you start porting a board, the RIOT build system provides the
0 commit comments