[rtems commit] dosfs: Fix Doxygen group placement

Sebastian Huber sebh at rtems.org
Wed Dec 2 12:19:06 UTC 2020


Module:    rtems
Branch:    master
Commit:    ef0fe8ee60fbad214569e144a9481d25b922c4d8
Changeset: http://git.rtems.org/rtems/commit/?id=ef0fe8ee60fbad214569e144a9481d25b922c4d8

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Dec  2 13:18:42 2020 +0100

dosfs: Fix Doxygen group placement

Update #3706.

---

 cpukit/doxygen.h                             |  8 --------
 cpukit/libfs/src/dosfs/fat.c                 |  2 +-
 cpukit/libfs/src/dosfs/fat.h                 | 17 +++++++++--------
 cpukit/libfs/src/dosfs/msdos.h               | 19 ++++++++++---------
 cpukit/libfs/src/dosfs/msdos_eval.c          |  2 +-
 cpukit/libfs/src/dosfs/msdos_file.c          |  2 +-
 cpukit/libfs/src/dosfs/msdos_format.c        |  2 +-
 cpukit/libfs/src/dosfs/msdos_handlers_dir.c  |  2 +-
 cpukit/libfs/src/dosfs/msdos_handlers_file.c |  2 +-
 cpukit/libfs/src/dosfs/msdos_init.c          |  2 +-
 cpukit/libfs/src/dosfs/msdos_misc.c          |  2 +-
 11 files changed, 27 insertions(+), 33 deletions(-)

diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h
index 01015ad..a60d138 100644
--- a/cpukit/doxygen.h
+++ b/cpukit/doxygen.h
@@ -39,14 +39,6 @@
  */
 
 /**
- * @defgroup libfs libfs
- * 
- * @ingroup FileSystemTypesAndMount
- * 
- * @brief libfs
- */
-
-/**
  * @defgroup libmisc_mouse Serial Mouse
  *
  * @ingroup RTEMSDeviceDrivers
diff --git a/cpukit/libfs/src/dosfs/fat.c b/cpukit/libfs/src/dosfs/fat.c
index c687477..2582fab 100644
--- a/cpukit/libfs/src/dosfs/fat.c
+++ b/cpukit/libfs/src/dosfs/fat.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup libfs
+ * @ingroup DOSFS
  *
  * @brief Low-level Operations on a Volume with a DOSFS FAT filesystem
  */
diff --git a/cpukit/libfs/src/dosfs/fat.h b/cpukit/libfs/src/dosfs/fat.h
index 064b474..129d49d 100644
--- a/cpukit/libfs/src/dosfs/fat.h
+++ b/cpukit/libfs/src/dosfs/fat.h
@@ -3,7 +3,7 @@
  *
  * @brief Constants/Data Structures/Prototypes on a Volume with FAT Filesystem
  *
- * @ingroup libfs_dosfs
+ * @ingroup DOSFS
  *
  * Constants/Data Structures/Prototypes for Low-Level
  * Operations on a Volume with FAT Filesystem
@@ -31,16 +31,16 @@
 #include <errno.h>
 #include <rtems/bdbuf.h>
 
-/**
- *  @defgroup libfs_dosfs FAT FileSystem
- *
- *  @ingroup libfs
- */
-/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/**
+ * @addtogroup DOSFS
+ *
+ * @{
+ */
+
 #ifndef RC_OK
 #define RC_OK 0
 #endif
@@ -546,8 +546,9 @@ fat_free_unique_ino(fat_fs_info_t                        *fs_info,
 int
 fat_sync(fat_fs_info_t *fs_info);
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif
-/**@}*/
 #endif /* __DOSFS_FAT_H__ */
diff --git a/cpukit/libfs/src/dosfs/msdos.h b/cpukit/libfs/src/dosfs/msdos.h
index ea94954..df9600a 100644
--- a/cpukit/libfs/src/dosfs/msdos.h
+++ b/cpukit/libfs/src/dosfs/msdos.h
@@ -1,9 +1,9 @@
 /**
  * @file
  *
- * @brief The MSDOS Filesystem Constants/Data Structures/Prototypes
+ * @ingroup DOSFS
  *
- * @ingroup libfs_msdos
+ * @brief The MSDOS Filesystem Constants/Data Structures/Prototypes
  */
 
 /*
@@ -29,16 +29,16 @@
 #include "fat.h"
 #include "fat_file.h"
 
-/**
- *  @defgroup libfs_msdos MSDOS FileSystem
- *
- *  @ingroup libfs
- */
-/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/**
+ * @addtogroup DOSFS
+ *
+ * @{
+ */
+
 #define MSDOS_NAME_NOT_FOUND_ERR  0x7D01
 
 /*
@@ -487,8 +487,9 @@ int msdos_sync(rtems_libio_t *iop);
 
 uint8_t msdos_lfn_checksum(const void *entry);
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif
-/**@}*/
 #endif /* __DOSFS_MSDOS_H__ */
diff --git a/cpukit/libfs/src/dosfs/msdos_eval.c b/cpukit/libfs/src/dosfs/msdos_eval.c
index e3e0f5f..7022aca 100644
--- a/cpukit/libfs/src/dosfs/msdos_eval.c
+++ b/cpukit/libfs/src/dosfs/msdos_eval.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup libfs
+ * @ingroup DOSFS
  *
  * @brief MSDOS Evaluation Routines
  */
diff --git a/cpukit/libfs/src/dosfs/msdos_file.c b/cpukit/libfs/src/dosfs/msdos_file.c
index da6e54b..e799105 100644
--- a/cpukit/libfs/src/dosfs/msdos_file.c
+++ b/cpukit/libfs/src/dosfs/msdos_file.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup libfs
+ * @ingroup DOSFS
  *
  * @brief MSDOS File Handlers Implementation
  */
diff --git a/cpukit/libfs/src/dosfs/msdos_format.c b/cpukit/libfs/src/dosfs/msdos_format.c
index e1e27f2..5786b0b 100644
--- a/cpukit/libfs/src/dosfs/msdos_format.c
+++ b/cpukit/libfs/src/dosfs/msdos_format.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup libfs
+ * @ingroup DOSFS
  *
  * @brief RTEMS MSDOS Format Functionality
  *
diff --git a/cpukit/libfs/src/dosfs/msdos_handlers_dir.c b/cpukit/libfs/src/dosfs/msdos_handlers_dir.c
index 77169d9..d00ee39 100644
--- a/cpukit/libfs/src/dosfs/msdos_handlers_dir.c
+++ b/cpukit/libfs/src/dosfs/msdos_handlers_dir.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup libfs
+ * @ingroup DOSFS
  *
  * @brief Directory Handlers Table for MSDOS FileSystem
  */
diff --git a/cpukit/libfs/src/dosfs/msdos_handlers_file.c b/cpukit/libfs/src/dosfs/msdos_handlers_file.c
index 73f67ac..052595d 100644
--- a/cpukit/libfs/src/dosfs/msdos_handlers_file.c
+++ b/cpukit/libfs/src/dosfs/msdos_handlers_file.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup libfs
+ * @ingroup DOSFS
  *
  * @brief File Operations Table for MSDOS FileSystem
  */
diff --git a/cpukit/libfs/src/dosfs/msdos_init.c b/cpukit/libfs/src/dosfs/msdos_init.c
index 2874172..67b16b6 100644
--- a/cpukit/libfs/src/dosfs/msdos_init.c
+++ b/cpukit/libfs/src/dosfs/msdos_init.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup libfs
+ * @ingroup DOSFS
  *
  * @brief Init Routine for MSDOS
  */
diff --git a/cpukit/libfs/src/dosfs/msdos_misc.c b/cpukit/libfs/src/dosfs/msdos_misc.c
index 397e590..5da4877 100644
--- a/cpukit/libfs/src/dosfs/msdos_misc.c
+++ b/cpukit/libfs/src/dosfs/msdos_misc.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup libfs
+ * @ingroup DOSFS
  *
  * @brief Miscellaneous Routines Implementation for MSDOS FileSystem
  */



More information about the vc mailing list