From aabc331494635649d567df6a7e16f0b6bb35e836 Mon Sep 17 00:00:00 2001 From: Gunar Schorcht Date: Thu, 14 Dec 2023 15:30:19 +0100 Subject: [PATCH] drivers/mtd: improve doc consistency for MTDs --- drivers/include/mtd_emulated.h | 1 + drivers/include/mtd_flashpage.h | 2 +- drivers/include/mtd_sdcard.h | 6 +++--- drivers/include/mtd_sdmmc.h | 8 ++++---- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/drivers/include/mtd_emulated.h b/drivers/include/mtd_emulated.h index 7c881d9a3a..1be5a89df2 100644 --- 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 index 932efc2bcc..5c2db79efb 100644 --- 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 index 2c7cabf92f..bbab36246d 100644 --- 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 */ diff --git a/drivers/include/mtd_sdmmc.h b/drivers/include/mtd_sdmmc.h index 913e3f6b9f..d3ba21d2e2 100644 --- 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 * @author Gunar Schorcht @@ -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;