Merge pull request #20184 from gschorcht/drivers/mtd/improve_doc_cons…

…istency drivers/mtd: improve doc consistency
RIOT-OS · Dec 14, 2023 · 4e291c4 · 4e291c4
2 parents d13e6c4 + aabc331
commit 4e291c4
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 11 deletions.
diff --git a/cpu/sam0_common/include/mtd_sam0_sdhc.h b/cpu/sam0_common/include/mtd_sam0_sdhc.h
@@ -7,9 +7,10 @@
  */
 
 /**
+ * @defgroup    drivers_mtd_sam0_sdhc MTD wrapper for SAM0 SDHC devices
  * @ingroup     drivers_storage
  * @ingroup     cpu_sam0_common_sdhc
- * @brief       Driver for SD-cards using mtd interface
+ * @brief       Driver for SD Cards connected to the SAM0 SDHC peripheral using the MTD interface
  *
  * @{
  *

diff --git a/drivers/include/mtd_emulated.h b/drivers/include/mtd_emulated.h
@@ -7,6 +7,7 @@
  */
 
 /**
+ * @defgroup    drivers_mtd_emulated MTD wrapper for emulated MTD devices
  * @ingroup     drivers_mtd
  * @{
  * @brief       MTD device that is emulated in RAM for test purposes

diff --git a/drivers/include/mtd_flashpage.h b/drivers/include/mtd_flashpage.h
@@ -7,7 +7,7 @@
  */
 
 /**
- * @defgroup    drivers_mtd_flashpage   Flashpage MTD
+ * @defgroup    drivers_mtd_flashpage MTD wrapper for Flashpage devices
  * @ingroup     drivers_storage
  * @brief       Driver for internal flash devices implementing flashpage interface
  *

diff --git a/drivers/include/mtd_sdcard.h b/drivers/include/mtd_sdcard.h
@@ -7,14 +7,14 @@
  */
 
 /**
- * @defgroup    drivers_mtd_sdcard mtd wrapper for sdcard_spi
+ * @defgroup    drivers_mtd_sdcard MTD wrapper for SPI SD Cards
  * @ingroup     drivers_storage
- * @brief       Driver for SD-cards using mtd interface
+ * @brief       Driver for SPI SD Cards using the MTD interface
  *
  * @{
  *
  * @file
- * @brief       Interface definition for mtd_sdcard driver
+ * @brief       Interface definition for the mtd_sdcard driver
  *
  * @author      Michel Rottleuthner <[email protected]>
  */

diff --git a/drivers/include/mtd_sdmmc.h b/drivers/include/mtd_sdmmc.h
@@ -8,14 +8,14 @@
  */
 
 /**
- * @defgroup    drivers_mtd_sdmmc mtd wrapper for sdmmc
+ * @defgroup    drivers_mtd_sdmmc MTD wrapper for SD/MMC devices
  * @ingroup     drivers_storage
- * @brief       Driver for SD Memory Cards and MMCs/eMMCs using mtd interface
+ * @brief       Driver for SD Memory Cards and MMCs/eMMCs using the MTD interface
  *
  * @{
  *
  * @file
- * @brief       Interface definition for mtd_sdmmc driver
+ * @brief       Interface definition for the mtd_sdmmc driver
  *
  * @author      Michel Rottleuthner <[email protected]>
  * @author      Gunar Schorcht <[email protected]>
@@ -46,7 +46,7 @@ typedef struct {
 } mtd_sdmmc_t;
 
 /**
- * @brief   sdcard device operations table for mtd
+ * @brief   SD/MMC device operations table for mtd
  */
 extern const mtd_desc_t mtd_sdmmc_driver;
 

diff --git a/drivers/include/sdcard_spi.h b/drivers/include/sdcard_spi.h
@@ -7,9 +7,9 @@
  */
 
 /**
- * @defgroup    drivers_sdcard_spi SPI SD-Card driver
+ * @defgroup    drivers_sdcard_spi SPI SD Card driver
  * @ingroup     drivers_storage
- * @brief       Driver for reading and writing sd-cards via spi interface.
+ * @brief       Driver for reading and writing SD Cards using the SPI.
  * @anchor      drivers_sdcard_spi
  * @{
  *
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,6 +7,7 @@ @@
      */
     /**
+     * @defgroup    drivers_mtd_emulated MTD wrapper for emulated MTD devices
      * @ingroup     drivers_mtd
      * @{
      * @brief       MTD device that is emulated in RAM for test purposes
@@ Expand Down @@