[rtems commit] libfs: Doxygen Enhancement Task #3
Jennifer Averett
jennifer at rtems.org
Fri Dec 28 13:47:15 UTC 2012
Module: rtems
Branch: master
Commit: 36f3207b277ecbd23a3d4081e4714fc543e25145
Changeset: http://git.rtems.org/rtems/commit/?id=36f3207b277ecbd23a3d4081e4714fc543e25145
Author: Alex Ivanov <alexivanov97 at gmail.com>
Date: Fri Dec 28 07:49:39 2012 -0600
libfs: Doxygen Enhancement Task #3
---
cpukit/libfs/src/defaults/default_chown.c | 6 ++++++
cpukit/libfs/src/defaults/default_close.c | 6 ++++++
cpukit/libfs/src/defaults/default_fchmod.c | 6 ++++++
cpukit/libfs/src/defaults/default_fsunmount.c | 6 ++++++
cpukit/libfs/src/defaults/default_link.c | 6 ++++++
cpukit/libfs/src/defaults/default_read.c | 6 ++++++
cpukit/libfs/src/defaults/default_statvfs.c | 6 ++++++
cpukit/libfs/src/rfs/rtems-rfs-buffer-bdbuf.c | 16 +++++++++-------
cpukit/libfs/src/rfs/rtems-rfs-buffer-devio.c | 15 +++++++--------
cpukit/libfs/src/rfs/rtems-rfs-buffer.c | 15 +++++++--------
cpukit/libfs/src/rfs/rtems-rfs-dir.c | 18 +++++++++---------
cpukit/libfs/src/rfs/rtems-rfs-file-system.c | 17 ++++++++---------
cpukit/libfs/src/rfs/rtems-rfs-file.c | 18 +++++++++---------
cpukit/libfs/src/rfs/rtems-rfs-format.c | 18 +++++++++---------
cpukit/libfs/src/rfs/rtems-rfs-group.c | 19 ++++++++++---------
cpukit/libfs/src/rfs/rtems-rfs-rtems-dir.c | 13 ++++++-------
cpukit/libfs/src/rfs/rtems-rfs-rtems-file.c | 20 ++++++++++----------
cpukit/libfs/src/rfs/rtems-rfs-rtems-utils.c | 14 +++++++-------
cpukit/libfs/src/rfs/rtems-rfs-shell.c | 14 +++++++-------
cpukit/libfs/src/rfs/rtems-rfs-trace.c | 13 ++++++-------
20 files changed, 146 insertions(+), 106 deletions(-)
diff --git a/cpukit/libfs/src/defaults/default_chown.c b/cpukit/libfs/src/defaults/default_chown.c
index dc457d2..2880f8e 100644
--- a/cpukit/libfs/src/defaults/default_chown.c
+++ b/cpukit/libfs/src/defaults/default_chown.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System Change Owner
+ */
+
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_close.c b/cpukit/libfs/src/defaults/default_close.c
index 3f650b9..5cf35e1 100644
--- a/cpukit/libfs/src/defaults/default_close.c
+++ b/cpukit/libfs/src/defaults/default_close.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System Close
+ */
+
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_fchmod.c b/cpukit/libfs/src/defaults/default_fchmod.c
index 5e4b605..0004279 100644
--- a/cpukit/libfs/src/defaults/default_fchmod.c
+++ b/cpukit/libfs/src/defaults/default_fchmod.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System Change File Mode
+ */
+
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_fsunmount.c b/cpukit/libfs/src/defaults/default_fsunmount.c
index 54dd80e..b5e1fd1 100644
--- a/cpukit/libfs/src/defaults/default_fsunmount.c
+++ b/cpukit/libfs/src/defaults/default_fsunmount.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System Unmount
+ */
+
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_link.c b/cpukit/libfs/src/defaults/default_link.c
index d4b3014..ab58c9b 100644
--- a/cpukit/libfs/src/defaults/default_link.c
+++ b/cpukit/libfs/src/defaults/default_link.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System Link
+ */
+
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_read.c b/cpukit/libfs/src/defaults/default_read.c
index 8a463e7..729b361 100644
--- a/cpukit/libfs/src/defaults/default_read.c
+++ b/cpukit/libfs/src/defaults/default_read.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System Read
+ */
+
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_statvfs.c b/cpukit/libfs/src/defaults/default_statvfs.c
index ed30ff5..139d0b0 100644
--- a/cpukit/libfs/src/defaults/default_statvfs.c
+++ b/cpukit/libfs/src/defaults/default_statvfs.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System Get Statistics
+ */
+
/*
* COPYRIGHT (c) 2010.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-buffer-bdbuf.c b/cpukit/libfs/src/rfs/rtems-rfs-buffer-bdbuf.c
index ef382ae..552e5df 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-buffer-bdbuf.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-buffer-bdbuf.c
@@ -1,19 +1,21 @@
-/*
- * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
- *
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution or at
- * http://www.rtems.com/license/LICENSE.
- */
/**
* @file
*
+ * @brief RTEMS File Systems Buffer Routines
* @ingroup rtems-rfs
*
* RTEMS File Systems Buffer Routines for the RTEMS libblock BD buffer cache.
*
*/
+/*
+ * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.com/license/LICENSE.
+ */
+
#if HAVE_CONFIG_H
#include "config.h"
#endif
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-buffer-devio.c b/cpukit/libfs/src/rfs/rtems-rfs-buffer-devio.c
index a855b8f..6e3a02c 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-buffer-devio.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-buffer-devio.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS File Systems Buffer Routines
+ * @ingroup rtems-rfs
+ */
+
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
*
@@ -5,14 +12,6 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
-/**
- * @file
- *
- * @ingroup rtems-rfs
- *
- * RTEMS File Systems Buffer Routines.
- *
- */
#if HAVE_CONFIG_H
#include "config.h"
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-buffer.c b/cpukit/libfs/src/rfs/rtems-rfs-buffer.c
index 5ab8617..0a7d3e4 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-buffer.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-buffer.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS File Systems Buffer Routines
+ * @ingroup rtems-rfs
+ */
+
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
*
@@ -5,14 +12,6 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
-/**
- * @file
- *
- * @ingroup rtems-rfs
- *
- * RTEMS File Systems Buffer Routines.
- *
- */
#if HAVE_CONFIG_H
#include "config.h"
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-dir.c b/cpukit/libfs/src/rfs/rtems-rfs-dir.c
index 677bdc8..18de308 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-dir.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-dir.c
@@ -1,17 +1,9 @@
-/*
- * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
- *
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution or at
- * http://www.rtems.com/license/LICENSE.
- */
/**
* @file
*
+ * @brief RTEMS File Systems Directory Routines
* @ingroup rtems-rfs
*
- * RTEMS File Systems Directory Routines.
- *
* These functions manage blocks in the directory format. A directory entry is
* a variable length record in the block. The entry consists of a length, hash
* and the string. The length allows the next entry to be located and the hash
@@ -23,6 +15,14 @@
* superblock.
*/
+/*
+ * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.com/license/LICENSE.
+ */
+
#if HAVE_CONFIG_H
#include "config.h"
#endif
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-file-system.c b/cpukit/libfs/src/rfs/rtems-rfs-file-system.c
index bceb08d..1090942 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-file-system.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-file-system.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief RTEMS File Systems Open
+ * @ingroup rtems-rfs
+ *
+ * Open the file system by reading the superblock and then the group data.
+ */
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
*
@@ -5,15 +13,6 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
-/**
- * @file
- *
- * @ingroup rtems-rfs
- *
- * RTEMS File Systems Open
- *
- * Open the file system by reading the superblock and then the group data.
- */
#if HAVE_CONFIG_H
#include "config.h"
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-file.c b/cpukit/libfs/src/rfs/rtems-rfs-file.c
index 0cf38c6..243a8af 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-file.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-file.c
@@ -1,20 +1,20 @@
-/*
- * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
- *
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution or at
- * http://www.rtems.com/license/LICENSE.
- */
/**
* @file
*
+ * @brief RTEMS File Systems File Routines
* @ingroup rtems-rfs
*
- * RTEMS File Systems File Routines.
- *
* These functions manage files.
*/
+/*
+ * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.com/license/LICENSE.
+ */
+
#if HAVE_CONFIG_H
#include "config.h"
#endif
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-format.c b/cpukit/libfs/src/rfs/rtems-rfs-format.c
index 6c20218..78c422c 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-format.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-format.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @brief RTEMS File Systems Format
+ * @ingroup rtems-rfs
+ *
+ * Format the file system ready for use.
+ */
+
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
*
@@ -5,15 +14,6 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
-/**
- * @file
- *
- * @ingroup rtems-rfs
- *
- * RTEMS File Systems Format
- *
- * Format the file system ready for use.
- */
#if HAVE_CONFIG_H
#include "config.h"
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-group.c b/cpukit/libfs/src/rfs/rtems-rfs-group.c
index 0edf83d..4a1f4a1 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-group.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-group.c
@@ -1,21 +1,22 @@
-/*
- * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
- *
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution or at
- * http://www.rtems.com/license/LICENSE.
- */
/**
* @file
*
+ * @brief RTEMS File Systems Group Routines
* @ingroup rtems-rfs
*
- * RTEMS File Systems Group Routines.
- *
* These functions open and close a group as well as manage bit allocations
* within a group.
*/
+/*
+ * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.com/license/LICENSE.
+ */
+
+
#if HAVE_CONFIG_H
#include "config.h"
#endif
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-rtems-dir.c b/cpukit/libfs/src/rfs/rtems-rfs-rtems-dir.c
index c04bbea..af35809 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-rtems-dir.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-rtems-dir.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS RFS Directory Access Routines
+ * @ingroup rtems-rfs
+ */
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
*
@@ -5,13 +11,6 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
-/**
- * @file
- *
- * @ingroup rtems-rfs
- *
- * RTEMS RFS Directory Access Routines
- */
#if HAVE_CONFIG_H
#include "config.h"
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-rtems-file.c b/cpukit/libfs/src/rfs/rtems-rfs-rtems-file.c
index 7de0403..ebcc64a 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-rtems-file.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-rtems-file.c
@@ -1,21 +1,21 @@
-/*
- * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
- *
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution or at
- * http://www.rtems.com/license/LICENSE.
- */
/**
* @file
*
+ * @brief RTEMS RFS File Handlers
* @ingroup rtems-rfs
- *
- * RTEMS RFS File Handlers
- *
+ *
* This file contains the set of handlers used to process operations on
* RFS file nodes.
*/
+/*
+ * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.com/license/LICENSE.
+ */
+
#if HAVE_CONFIG_H
#include "config.h"
#endif
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-rtems-utils.c b/cpukit/libfs/src/rfs/rtems-rfs-rtems-utils.c
index 76d0392..04108fb 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-rtems-utils.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-rtems-utils.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Set of Utility Functions to Support RTEMS RFS on RTEMS
+ * @ingroup rtems-rfs
+ */
+
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
*
@@ -5,13 +12,6 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
-/**
- * @file
- *
- * @ingroup rtems-rfs
- *
- * Set of utility functions to support RTEMS RFS on RTEMS.
- */
#if HAVE_CONFIG_H
#include "config.h"
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-shell.c b/cpukit/libfs/src/rfs/rtems-rfs-shell.c
index a1ed928..0e930a0 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-shell.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-shell.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS File Systems Shell Commands Support
+ * @ingroup rtems-rfs
+ */
+
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
*
@@ -5,13 +12,6 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
-/**
- * @file
- *
- * @ingroup rtems-rfs
- *
- * RTEMS File Systems Shell Commands Support
- */
#if HAVE_CONFIG_H
#include "config.h"
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-trace.c b/cpukit/libfs/src/rfs/rtems-rfs-trace.c
index df0f54a..60a9e0c 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-trace.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-trace.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS File Systems Trace Support
+ * @ingroup rtems-rfs
+ */
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
*
@@ -5,13 +11,6 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
-/**
- * @file
- *
- * @ingroup rtems-rfs
- *
- * RTEMS File Systems Trace Support
- */
#if HAVE_CONFIG_H
#include "config.h"
More information about the vc
mailing list