From 204a608c24c3fb3d8acdd8630b6e58cd0f02e330 Mon Sep 17 00:00:00 2001
From: chrysn <chrysn@fsfe.org>
Date: Tue, 16 Feb 2021 15:40:25 +0100
Subject: [PATCH] doc: Make bootloaders visible in modules

---
 bootloaders/doc.txt                         | 5 +++++
 bootloaders/riotboot/{README.md => doc.txt} | 8 +++++++-
 bootloaders/riotboot/main.c                 | 1 -
 doc/doxygen/riot.doxyfile                   | 1 +
 4 files changed, 13 insertions(+), 2 deletions(-)
 create mode 100644 bootloaders/doc.txt
 rename bootloaders/riotboot/{README.md => doc.txt} (98%)

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 98%
rename from bootloaders/riotboot/README.md
rename to bootloaders/riotboot/doc.txt
index 768ee8ca1b..c3845fef9f 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=<board> make -C tests/riotboot flash test
+    $ BOARD=<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).
@@ -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 \