[rtems commit] nfsclient: Rework Doxygen groups
Sebastian Huber
sebh at rtems.org
Wed Dec 2 12:05:23 UTC 2020
Module: rtems
Branch: master
Commit: 295b05f9652f6e69ce659f43fe41563cee9b0e6b
Changeset: http://git.rtems.org/rtems/commit/?id=295b05f9652f6e69ce659f43fe41563cee9b0e6b
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Wed Dec 2 13:02:58 2020 +0100
nfsclient: Rework Doxygen groups
Update #3706.
---
cpukit/doxygen.h | 8 --------
cpukit/libfs/src/nfsclient/proto/mount_prot.h | 19 +++++++++++--------
cpukit/libfs/src/nfsclient/proto/mount_prot_xdr.c | 2 +-
cpukit/libfs/src/nfsclient/proto/nfs_prot.h | 4 ++--
cpukit/libfs/src/nfsclient/proto/nfs_prot_xdr.c | 2 +-
cpukit/libfs/src/nfsclient/src/nfs.c | 2 +-
cpukit/libfs/src/nfsclient/src/rpcio.c | 2 +-
cpukit/libfs/src/nfsclient/src/sock_mbuf.c | 2 +-
cpukit/libfs/src/nfsclient/src/xdr_mbuf.c | 2 +-
cpukit/libnetworking/librtemsNfs.h | 9 +++++----
10 files changed, 24 insertions(+), 28 deletions(-)
diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h
index 2d9cf29..01015ad 100644
--- a/cpukit/doxygen.h
+++ b/cpukit/doxygen.h
@@ -47,14 +47,6 @@
*/
/**
- * @defgroup nfsclient nfs Client
- *
- * @ingroup FileSystemTypesAndMount
- *
- * @brief nfs Client
- */
-
-/**
* @defgroup libmisc_mouse Serial Mouse
*
* @ingroup RTEMSDeviceDrivers
diff --git a/cpukit/libfs/src/nfsclient/proto/mount_prot.h b/cpukit/libfs/src/nfsclient/proto/mount_prot.h
index a5cac29..11ef3cc 100644
--- a/cpukit/libfs/src/nfsclient/proto/mount_prot.h
+++ b/cpukit/libfs/src/nfsclient/proto/mount_prot.h
@@ -3,7 +3,7 @@
*
* @brief Nfsclient Mount Prot
*
- * @ingroup rtems-nfsclient
+ * @ingroup RTEMSFileSystemNFSMountProt
*/
#ifndef _MOUNT_PROT_H_RPCGEN
@@ -11,16 +11,18 @@
#include <rpc/rpc.h>
-/**
- * @defgroup libfs_nfsclient_mount_prot Mount Prot
- *
- * @ingroup libfs
- */
-/**@{*/
#ifdef __cplusplus
extern "C" {
#endif
+/**
+ * @defgroup RTEMSFileSystemNFSMountProt Mount Prot
+ *
+ * @ingroup RTEMSFileSystemNFS
+ *
+ * @{
+ */
+
#define MNTPATHLEN 1024
#define MNTNAMLEN 255
#define FHSIZE 32
@@ -145,8 +147,9 @@ extern bool_t xdr_exportnode ();
#endif /* K&R C */
+/**@}*/
+
#ifdef __cplusplus
}
#endif
-/**@}*/
#endif /* !_MOUNT_PROT_H_RPCGEN */
diff --git a/cpukit/libfs/src/nfsclient/proto/mount_prot_xdr.c b/cpukit/libfs/src/nfsclient/proto/mount_prot_xdr.c
index 05bace6..85a7b9b 100644
--- a/cpukit/libfs/src/nfsclient/proto/mount_prot_xdr.c
+++ b/cpukit/libfs/src/nfsclient/proto/mount_prot_xdr.c
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup libfs_nfsclient_mount_prot Mount Prot
+ * @ingroup RTEMSFileSystemNFSMountProt Mount Prot
*
* @brief Mount Prot XDR
*/
diff --git a/cpukit/libfs/src/nfsclient/proto/nfs_prot.h b/cpukit/libfs/src/nfsclient/proto/nfs_prot.h
index 2011c52..48bf0fb 100644
--- a/cpukit/libfs/src/nfsclient/proto/nfs_prot.h
+++ b/cpukit/libfs/src/nfsclient/proto/nfs_prot.h
@@ -9,9 +9,9 @@
#include <rpc/rpc.h>
/**
- * @defgroup libfs_nfsclient_nfs_prot NFS Prot
+ * @defgroup RTEMSFileSystemNFSProt NFS Prot
*
- * @ingroup nfsclient
+ * @ingroup RTEMSFileSystemNFS
*/
/**@{*/
#ifdef __cplusplus
diff --git a/cpukit/libfs/src/nfsclient/proto/nfs_prot_xdr.c b/cpukit/libfs/src/nfsclient/proto/nfs_prot_xdr.c
index c7a51a7..8d541c9 100644
--- a/cpukit/libfs/src/nfsclient/proto/nfs_prot_xdr.c
+++ b/cpukit/libfs/src/nfsclient/proto/nfs_prot_xdr.c
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup libfs_nfsclient_nfs_prot NFS Prot
+ * @ingroup RTEMSFileSystemNFSProt NFS Prot
*
* @brief NFS Prot XDR
*/
diff --git a/cpukit/libfs/src/nfsclient/src/nfs.c b/cpukit/libfs/src/nfsclient/src/nfs.c
index c482db9..bc9a2c6 100644
--- a/cpukit/libfs/src/nfsclient/src/nfs.c
+++ b/cpukit/libfs/src/nfsclient/src/nfs.c
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup libfs
+ * @ingroup RTEMSFileSystemNFS
*
* @brief NFS Client Implementation for RTEMS
*
diff --git a/cpukit/libfs/src/nfsclient/src/rpcio.c b/cpukit/libfs/src/nfsclient/src/rpcio.c
index 2e36ede..ce5abe3 100644
--- a/cpukit/libfs/src/nfsclient/src/rpcio.c
+++ b/cpukit/libfs/src/nfsclient/src/rpcio.c
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup libfs
+ * @ingroup RTEMSFileSystemNFS
*
* @brief RPC Multiplexor for a Multitasking Environment
*
diff --git a/cpukit/libfs/src/nfsclient/src/sock_mbuf.c b/cpukit/libfs/src/nfsclient/src/sock_mbuf.c
index f48cd0d..fa519f7 100644
--- a/cpukit/libfs/src/nfsclient/src/sock_mbuf.c
+++ b/cpukit/libfs/src/nfsclient/src/sock_mbuf.c
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup libfs
+ * @ingroup RTEMSFileSystemNFS
*
* @brief Sock Mbuf
*/
diff --git a/cpukit/libfs/src/nfsclient/src/xdr_mbuf.c b/cpukit/libfs/src/nfsclient/src/xdr_mbuf.c
index cf35c20..20f2f9f 100644
--- a/cpukit/libfs/src/nfsclient/src/xdr_mbuf.c
+++ b/cpukit/libfs/src/nfsclient/src/xdr_mbuf.c
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup libfs
+ * @ingroup RTEMSFileSystemNFS
*
* @brief XDR Implementation Using mbuf Buffers
*
diff --git a/cpukit/libnetworking/librtemsNfs.h b/cpukit/libnetworking/librtemsNfs.h
index 74aeffc..ce83d03 100644
--- a/cpukit/libnetworking/librtemsNfs.h
+++ b/cpukit/libnetworking/librtemsNfs.h
@@ -1,9 +1,9 @@
/**
* @file
*
- * @brief Public Interface to the NFS Client Library for RTEMS
+ * @ingroup RTEMSFileSystemNFS
*
- * @ingroup rtems-nfsclient
+ * @brief This header file provides interfaces of the NFSv2 client.
*/
/*
@@ -57,9 +57,10 @@
#define LIB_RTEMS_NFS_CLIENT_H
/**
- * @defgroup rtems-nfsclient NFS Client Library
+ * @defgroup RTEMSFileSystemNFS NFSv2 Client
+ *
+ * @ingroup FileSystemTypesAndMount
*
- * @ingroup nfsclient
* @{
*/
More information about the vc
mailing list