doc: Make bootloaders visible in modules

This commit is contained in:
chrysn 2021-02-16 15:40:25 +01:00
parent 856f246131
commit 204a608c24
4 changed files with 13 additions and 2 deletions

5
bootloaders/doc.txt Normal file
View File

@ -0,0 +1,5 @@
/**
* @defgroup bootloaders Bootloaders
* @brief Applications that facilitate the startup process in presence of upgradable firmware
*
*/

View File

@ -1,3 +1,7 @@
/**
@defgroup bootloader_riotboot riotboot
@ingroup bootloaders
# Overview # Overview
This folder contains a simple bootloader called "riotboot". This folder contains a simple bootloader called "riotboot".
A header with metadata of length `RIOTBOOT_HDR_LEN` precedes A header with metadata of length `RIOTBOOT_HDR_LEN` precedes
@ -151,3 +155,5 @@ offset and a defined firmware size. To get an idea look at
Additional remarks: Additional remarks:
- If your are in Big-Endian, you may need to further adapt some part of the code. - If your are in Big-Endian, you may need to further adapt some part of the code.
*/

View File

@ -8,7 +8,6 @@
*/ */
/** /**
* @defgroup bootloaders RIOT compatible bootloaders
* @ingroup bootloaders * @ingroup bootloaders
* @{ * @{
* *

View File

@ -757,6 +757,7 @@ INPUT = ../../doc.txt \
../../core \ ../../core \
../../cpu \ ../../cpu \
../../boards \ ../../boards \
../../bootloaders \
../../drivers \ ../../drivers \
../../pkg \ ../../pkg \
../../sys \ ../../sys \