diff --git a/bootloaders/doc.txt b/bootloaders/doc.txt new file mode 100644 index 0000000000..46b2572b74 --- /dev/null +++ b/bootloaders/doc.txt @@ -0,0 +1,5 @@ +/** + * @defgroup bootloaders Bootloaders + * @brief Applications that facilitate the startup process in presence of upgradable firmware + * + */ diff --git a/bootloaders/riotboot/README.md b/bootloaders/riotboot/doc.txt similarity index 96% rename from bootloaders/riotboot/README.md rename to bootloaders/riotboot/doc.txt index 768ee8ca1b..b54ae897b1 100644 --- a/bootloaders/riotboot/README.md +++ b/bootloaders/riotboot/doc.txt @@ -1,3 +1,7 @@ +/** +@defgroup bootloader_riotboot riotboot +@ingroup bootloaders + # Overview This folder contains a simple bootloader called "riotboot". A header with metadata of length `RIOTBOOT_HDR_LEN` precedes @@ -48,7 +52,7 @@ no image will be booted and the bootloader will enter `while(1);` endless loop. # Requirements Try to compile and run tests/riotboot: -$ BOARD= make -C tests/riotboot flash test + $ BOARD= make -C tests/riotboot flash test If the test succeeds, your board is supported. Else you can try to port riotboot to your board (see the below porting guide). @@ -103,7 +107,7 @@ flash` if the `riotboot` feature is used. ## Testing riotboot -See [tests/riotboot/README.md](https://github.com/RIOT-OS/RIOT/blob/master/tests/riotboot/README.md). +See tests/riotboot/README.md. # Quick riotboot porting guide @@ -151,3 +155,5 @@ offset and a defined firmware size. To get an idea look at Additional remarks: - If your are in Big-Endian, you may need to further adapt some part of the code. + +*/ diff --git a/bootloaders/riotboot/main.c b/bootloaders/riotboot/main.c index 8ee9268c0b..2e41b073b4 100644 --- a/bootloaders/riotboot/main.c +++ b/bootloaders/riotboot/main.c @@ -8,7 +8,6 @@ */ /** - * @defgroup bootloaders RIOT compatible bootloaders * @ingroup bootloaders * @{ * diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 4271a5b8a5..d6212b4ea2 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -757,6 +757,7 @@ INPUT = ../../doc.txt \ ../../core \ ../../cpu \ ../../boards \ + ../../bootloaders \ ../../drivers \ ../../pkg \ ../../sys \