libfs: Doxygen Enhancement Task #5

13 files changed, 165 insertions, 91 deletions

diff --git a/cpukit/libfs/src/nfsclient/proto/mount_prot.h b/cpukit/libfs/src/nfsclient/proto/mount_prot.h
index 1cde517aea..e74a3cd688 100644
--- a/cpukit/libfs/src/nfsclient/proto/mount_prot.h
+++ b/cpukit/libfs/src/nfsclient/proto/mount_prot.h
@@ -8,7 +8,12 @@
 
 #include <rpc/rpc.h>
 
-
+/**
+ *  @defgroup libfs_nfsclient_mount_prot Mount Prot
+ *
+ *  @ingroup libfs
+ */
+/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -140,5 +145,5 @@ extern bool_t xdr_exportnode ();
 #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 b439ef341f..a7950c1b39 100644
--- a/cpukit/libfs/src/nfsclient/proto/mount_prot_xdr.c
+++ b/cpukit/libfs/src/nfsclient/proto/mount_prot_xdr.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Mount Prot XDR
+ * @ingroup libfs_nfsclient_mount_prot Mount Prot
+ */
+
 /*
  * Please do not edit this file.
  * It was generated using rpcgen.
diff --git a/cpukit/libfs/src/nfsclient/proto/nfs_prot.h b/cpukit/libfs/src/nfsclient/proto/nfs_prot.h
index 45fddf3ee0..80fd2db9d7 100644
--- a/cpukit/libfs/src/nfsclient/proto/nfs_prot.h
+++ b/cpukit/libfs/src/nfsclient/proto/nfs_prot.h
@@ -8,7 +8,12 @@
 
 #include <rpc/rpc.h>
 
-
+/**
+ *  @defgroup libfs_nfsclient_nfs_prot NFS Prot
+ *
+ *  @ingroup libfs
+ */
+/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -451,5 +456,5 @@ extern bool_t xdr_statfsres ();
 #ifdef __cplusplus
 }
 #endif
-
+/**@}*/
 #endif /* !_NFS_PROT_H_RPCGEN */
diff --git a/cpukit/libfs/src/nfsclient/proto/nfs_prot_xdr.c b/cpukit/libfs/src/nfsclient/proto/nfs_prot_xdr.c
index cde005e2b4..40496a72ff 100644
--- a/cpukit/libfs/src/nfsclient/proto/nfs_prot_xdr.c
+++ b/cpukit/libfs/src/nfsclient/proto/nfs_prot_xdr.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief NFS Prot XDR
+ * @ingroup libfs_nfsclient_nfs_prot NFS Prot
+ */
+
 /*
  * Please do not edit this file.
  * It was generated using rpcgen.
diff --git a/cpukit/libfs/src/nfsclient/src/cexphelp.c b/cpukit/libfs/src/nfsclient/src/cexphelp.c
index d0406ad33a..09c73774f6 100644
--- a/cpukit/libfs/src/nfsclient/src/cexphelp.c
+++ b/cpukit/libfs/src/nfsclient/src/cexphelp.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief CEXP Help Information
+ * @ingroup libfs
+ */
+
 #if HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/cpukit/libfs/src/nfsclient/src/dirutils.c b/cpukit/libfs/src/nfsclient/src/dirutils.c
index 357aab96df..65e2053ddc 100644
--- a/cpukit/libfs/src/nfsclient/src/dirutils.c
+++ b/cpukit/libfs/src/nfsclient/src/dirutils.c
@@ -1,8 +1,13 @@
-/* very crude and basic fs utilities for testing the NFS */
-
-/* Till Straumann, <strauman@slac.stanford.edu>, 10/2002 */
+/**
+ * @file
+ *
+ * @brief Basic NFS Filesystem Utilities for Testing the NFS
+ * @ingroup libfs
+ */
 
 /*
+ * Author: Till Straumann, <strauman@slac.stanford.edu>, 10/2002
+ *
  * Authorship
  * ----------
  * This software (NFS-2 client implementation for RTEMS) was created by
diff --git a/cpukit/libfs/src/nfsclient/src/nfs.c b/cpukit/libfs/src/nfsclient/src/nfs.c
index 2627726dc0..e4e9d88bfe 100644
--- a/cpukit/libfs/src/nfsclient/src/nfs.c
+++ b/cpukit/libfs/src/nfsclient/src/nfs.c
@@ -1,15 +1,20 @@
-/* NFS client implementation for RTEMS; hooks into the RTEMS filesystem */
-
-/* Author: Till Straumann <strauman@slac.stanford.edu> 2002 */
+/**
+ * @file
+ *
+ * @brief NFS Client Implementation for RTEMS
+ * @ingroup libfs
+ *
+ * Hooks Into the RTEMS NFS Filesystem
+ */
 
 /*
+ * Author: Till Straumann <strauman@slac.stanford.edu>, 2002
+ *
  * Hacked on by others.
  *
  * Modifications to support reference counting in the file system are
  * Copyright (c) 2012 embedded brains GmbH.
- */
-
-/*
+ *
  * Authorship
  * ----------
  * This software (NFS-2 client implementation for RTEMS) was created by
@@ -1313,7 +1318,7 @@ int		len;
 	}
 
 	memcpy(&psa->sin_addr, h->h_addr, sizeof (struct in_addr));
-  
+
   /* END OF NON-THREAD SAFE REGION */
 
 	psa->sin_family = AF_INET;
@@ -1770,13 +1775,13 @@ char				*path     = mt_entry->dev;
     fprintf (stderr, "error: initialising RPC\n");
     return -1;
   }
-  
+
 	nfsInit(0, 0);
 
 #if 0
 	printf("Trying to mount %s on %s\n",path,mntpoint);
 #endif
-  
+
 	if ( buildIpAddr(&uid, &gid, &host, &saddr, &path) )
 		return -1;
 
diff --git a/cpukit/libfs/src/nfsclient/src/nfs.modini.c b/cpukit/libfs/src/nfsclient/src/nfs.modini.c
index 22095cf53f..57adf23aa1 100644
--- a/cpukit/libfs/src/nfsclient/src/nfs.modini.c
+++ b/cpukit/libfs/src/nfsclient/src/nfs.modini.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief NFS Module Initialize
+ * @ingroup libfs
+ */
+
 #if HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/cpukit/libfs/src/nfsclient/src/nfsTest.c b/cpukit/libfs/src/nfsclient/src/nfsTest.c
index 18bd0a3cb4..5b6951af58 100644
--- a/cpukit/libfs/src/nfsclient/src/nfsTest.c
+++ b/cpukit/libfs/src/nfsclient/src/nfsTest.c
@@ -1,8 +1,10 @@
-/* Test program for evaluating NFS read throughput */
-
-/* Author: Till Straumann <strauman@slac.stanford.edu>, 2006 */
-
-/* This test code allows for evaluating NFS read performance
+/**
+ * @file
+ *
+ * @brief Test Program for Evaluating NFS Read Throughput
+ * @ingroup libfs
+ *
+ * This test code allows for evaluating NFS read performance
  * under various scenarios:
  *  - synchronous reads with various buffer sizes (select
  *    'num_readers' == 0, see below).
@@ -48,7 +50,12 @@
  *    performed at 'big block' boundaries (num_readers * chunk_size).
  */
 
+
+
+
 /*
+ * Author: Till Straumann <strauman@slac.stanford.edu>, 2006
+ *
  * Authorship
  * ----------
  * This software (NFS-2 client implementation for RTEMS) was created by
diff --git a/cpukit/libfs/src/nfsclient/src/rpcio.c b/cpukit/libfs/src/nfsclient/src/rpcio.c
index eeadd53f58..e1bc4c59ba 100644
--- a/cpukit/libfs/src/nfsclient/src/rpcio.c
+++ b/cpukit/libfs/src/nfsclient/src/rpcio.c
@@ -1,8 +1,10 @@
-/* RPC multiplexor for a multitasking environment */
-
-/* Author: Till Straumann <strauman@slac.stanford.edu>, 2002 */
-
-/* This code funnels arbitrary task's UDP/RPC requests
+/**
+ * @file
+ *
+ * @brief RPC Multiplexor for a Multitasking Environment
+ * @ingroup libfs
+ *
+ * This code funnels arbitrary task's UDP/RPC requests
  * through one socket to arbitrary servers.
  * The replies are gathered and dispatched to the
  * requestors.
@@ -15,6 +17,8 @@
  */
 
 /*
+ * Author: Till Straumann <strauman@slac.stanford.edu>, 2002
+ *
  * Authorship
  * ----------
  * This software (NFS-2 client implementation for RTEMS) was created by
diff --git a/cpukit/libfs/src/nfsclient/src/rpcio.modini.c b/cpukit/libfs/src/nfsclient/src/rpcio.modini.c
index 7aa802fe51..f0359974de 100644
--- a/cpukit/libfs/src/nfsclient/src/rpcio.modini.c
+++ b/cpukit/libfs/src/nfsclient/src/rpcio.modini.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RPCIO Module Initialize
+ * @ingroup libfs
+ */
+
 #if HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/cpukit/libfs/src/nfsclient/src/sock_mbuf.c b/cpukit/libfs/src/nfsclient/src/sock_mbuf.c
index e07c63bcf2..3f07b757b5 100644
--- a/cpukit/libfs/src/nfsclient/src/sock_mbuf.c
+++ b/cpukit/libfs/src/nfsclient/src/sock_mbuf.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Sock Mbuf
+ * @ingroup libfs
+ */
+
 /*
  *  NOTE:
  *    This is derived from libnetworking/rtems/rtems_syscall.c
@@ -9,70 +16,64 @@
  *    		 Till Straumann, <strauman@slac.stanford.edu>
  *    Licensing: 'LICENSE.NET' file in the RTEMS top source directory
  *               for more information.
+ *
+ * The RTEMS TCP/IP stack is a port of the FreeBSD TCP/IP stack.  The following
+ * copyright and licensing information applies to this code.
+ *
+ * This code is found under the c/src/libnetworking directory but does not
+ * constitute the entire contents of that subdirectory.
+ *
+ *
+ * Copyright (c) 1980, 1983, 1988, 1993
+ *	The Regents of the University of California.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgment:
+ * 	This product includes software developed by the University of
+ * 	California, Berkeley and its contributors.
+ * 4. Neither the name of the University nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+
+ * Portions Copyright (c) 1993 by Digital Equipment Corporation.
+
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies, and that
+ * the name of Digital Equipment Corporation not be used in advertising or
+ * publicity pertaining to distribution of the document or software without
+ * specific, written prior permission.
+
+ * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
+ * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
+ * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+ * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
+ * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
+ * SOFTWARE.
  */
 
-/*
-The RTEMS TCP/IP stack is a port of the FreeBSD TCP/IP stack.  The following
-copyright and licensing information applies to this code.
-
-This code is found under the c/src/libnetworking directory but does not
-constitute the entire contents of that subdirectory.
-
-=============================================================================
-
-Copyright (c) 1980, 1983, 1988, 1993
-	The Regents of the University of California.  All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the distribution.
-3. All advertising materials mentioning features or use of this software
-   must display the following acknowledgment:
-	This product includes software developed by the University of
-	California, Berkeley and its contributors.
-4. Neither the name of the University nor the names of its contributors
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGE.
-
--
-Portions Copyright (c) 1993 by Digital Equipment Corporation.
-
-Permission to use, copy, modify, and distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies, and that
-the name of Digital Equipment Corporation not be used in advertising or
-publicity pertaining to distribution of the document or software without
-specific, written prior permission.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
-WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
-OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
-CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
-DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
-PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
-ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
-SOFTWARE.
-
-=============================================================================
-*/
-
 #if HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/cpukit/libfs/src/nfsclient/src/xdr_mbuf.c b/cpukit/libfs/src/nfsclient/src/xdr_mbuf.c
index 3c73639750..0f71538419 100644
--- a/cpukit/libfs/src/nfsclient/src/xdr_mbuf.c
+++ b/cpukit/libfs/src/nfsclient/src/xdr_mbuf.c
@@ -1,8 +1,15 @@
-/* xdr_mbuf is derived from xdr_mem */
-
-/* Author (mbuf specifica): Till Straumann <strauman@slac.stanford.edu>, 10/2002 */
+/**
+ * @file
+ *
+ * @brief XDR Implementation Using mbuf Buffers
+ * @ingroup libfs
+ *
+ * xdr_mbuf is derived from xdr_mem
+ */
 
 /*
+ * Author (mbuf specifica): Till Straumann <strauman@slac.stanford.edu>, 10/2002
+ *
  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
  * unrestricted use provided that this legend is included on all tape
  * media and as a part of the software program in whole or part.  Users