summaryrefslogtreecommitdiffstats
path: root/cpukit/libfs/src/rfs
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 13:20:34 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 17:06:47 -0600
commita15eaaf9fdba8a9311623ae44711d17701a19d30 (patch)
treeeb6f4439e820390ad8b0f8ed5a10ed6835461548 /cpukit/libfs/src/rfs
parentscore: Doxygen Clean Up Task #14 (diff)
downloadrtems-a15eaaf9fdba8a9311623ae44711d17701a19d30.tar.bz2
cpukit: Doxygen group fixes and many warnings addressed
The output of the modules.html is much improved. Most filesystem and POSIX API related groups are properly nested. Some formatting issues were addressed as were multiple inconsistencies.
Diffstat (limited to 'cpukit/libfs/src/rfs')
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-block-pos.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-block.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-buffer.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-data.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-dir.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-file-system.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-file.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-format.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-group.h10
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-inode.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-link.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-mutex.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-rtems.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-shell.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-trace.h2
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs.h10
19 files changed, 31 insertions, 23 deletions
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h b/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h
index c2497764e2..b8ed9c8d54 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File Systems Bitmap Routines
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Bitmap Routines.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h b/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h
index 1aab489027..3a3aab6b97 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File Systems Block Position and Size Management
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Block Position and Size Management.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-block.h b/cpukit/libfs/src/rfs/rtems-rfs-block.h
index 928186f52b..ee758bafb3 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-block.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-block.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File Systems Block Management
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Block Management.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-buffer.h b/cpukit/libfs/src/rfs/rtems-rfs-buffer.h
index ec35e648d7..40b5891a2f 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-buffer.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-buffer.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* @brief Maps Blocks to the Media Interface Layers
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-data.h b/cpukit/libfs/src/rfs/rtems-rfs-data.h
index 0e20423adc..954f4bc697 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-data.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-data.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Data
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Data.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h b/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h
index 46b2719a7e..0b2d7a40b6 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h
@@ -3,7 +3,7 @@
*
* @brief Provides a 32bit Hash of a String used to Search a Directory
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Directory Hash provides a 32bit hash of a string. This is
* used to search a directory.
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-dir.h b/cpukit/libfs/src/rfs/rtems-rfs-dir.h
index ddfcb5418e..91ea713710 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-dir.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-dir.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Directory Support
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Directory Support
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h b/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h
index 19b03587e1..8010c40a16 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File Systems Data Forward Declaration
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Data forward decl.
*/
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-file-system.h b/cpukit/libfs/src/rfs/rtems-rfs-file-system.h
index 1d059ae92c..7c80aed5da 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-file-system.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-file-system.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Data
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Data
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-file.h b/cpukit/libfs/src/rfs/rtems-rfs-file.h
index 9665c60ea5..efafb88e56 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-file.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-file.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System File Support
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System File Support
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-format.h b/cpukit/libfs/src/rfs/rtems-rfs-format.h
index f0d9f0c2b1..dd2b08d2a2 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-format.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-format.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* @brief RTEMS File System Format
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-group.h b/cpukit/libfs/src/rfs/rtems-rfs-group.h
index 90c6a9aa88..595a3c0886 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-group.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-group.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File Systems Group Management
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Group Management.
*
@@ -23,11 +23,11 @@
#define _RTEMS_RFS_GROUP_H_
/**
- * @defgroup rtems-rfs FS Group Management
+ * @ingroup rtems_rfs
*
- * @ingroup rfs
- * @{
+ * RTEMS File System Group Management
*/
+/**@{*/
#include <rtems/rfs/rtems-rfs-trace.h>
#include <rtems/rfs/rtems-rfs-bitmaps.h>
@@ -178,4 +178,4 @@ int rtems_rfs_group_usage (rtems_rfs_file_system* fs,
size_t* inodes);
/** @} */
-#endif \ No newline at end of file
+#endif
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-inode.h b/cpukit/libfs/src/rfs/rtems-rfs-inode.h
index a8be80f6ff..773db4751d 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-inode.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-inode.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Information Node
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Information Node.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-link.h b/cpukit/libfs/src/rfs/rtems-rfs-link.h
index 6a1cf18f6d..c10e336d49 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-link.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-link.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Link Support
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Link Support
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-mutex.h b/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
index edf67f4f7b..a37d9fee72 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
@@ -3,7 +3,7 @@
*
* @brief RTEMS File System Mutex
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System Mutex.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-rtems.h b/cpukit/libfs/src/rfs/rtems-rfs-rtems.h
index bbff3aeaf3..d923999f62 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-rtems.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-rtems.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System RTEMS Header file.
*
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-shell.h b/cpukit/libfs/src/rfs/rtems-rfs-shell.h
index a917b8556c..46f3d2902f 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-shell.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-shell.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
* @brief RTEMS File Systems Shell Commands
*
* RTEMS File Systems Shell commands provide a CLI interface to support and
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-trace.h b/cpukit/libfs/src/rfs/rtems-rfs-trace.h
index 030e6c2058..7ffdea0d56 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-trace.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-trace.h
@@ -4,7 +4,7 @@
* @brief Manages the Trace and Debugging Features of the
* RTEMS RFS File System
*
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File Systems Trace manages the trace and debugging features of the
* RTEMS RFS file system. The design allows all tracing code and strings to be
diff --git a/cpukit/libfs/src/rfs/rtems-rfs.h b/cpukit/libfs/src/rfs/rtems-rfs.h
index b1684e0ebd..ffd2f806fb 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs.h
@@ -2,7 +2,7 @@
* @file
*
* @brief RFS File system Initialization
- * @ingroup rtems-rfs
+ * @ingroup rtems_rfs
*
* RTEMS File System
*
@@ -23,8 +23,16 @@
#include <rtems/fs.h>
/**
+ * @defgroup rtems_rfs RTEMS File System Group Management
+ *
+ * @ingroup FileSystemTypesAndMount
+ */
+/**@{*/
+
+/**
* Initialise the RFS File system.
*/
int rtems_rfs_rtems_initialise (rtems_filesystem_mount_table_entry_t *mt_entry);
+/**@}*/
#endif