[rtems commit] libfs: Doxygen Enhancement Task #4

Jennifer Averett jennifer at rtems.org
Fri Dec 28 14:23:17 UTC 2012


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

Author:    Ayush Awasthi <kolaveridi87 at gmail.com>
Date:      Fri Dec 28 08:26:30 2012 -0600

libfs: Doxygen Enhancement Task #4

---

 .../libfs/src/defaults/default_are_nodes_equal.c   |    7 +++++++
 cpukit/libfs/src/defaults/default_clone.c          |    7 +++++++
 cpukit/libfs/src/defaults/default_eval_path.c      |    7 +++++++
 cpukit/libfs/src/defaults/default_fsmount.c        |    7 +++++++
 cpukit/libfs/src/defaults/default_fstat.c          |    7 +++++++
 cpukit/libfs/src/defaults/default_fsync.c          |    7 +++++++
 cpukit/libfs/src/defaults/default_fsync_success.c  |    7 +++++++
 cpukit/libfs/src/defaults/default_ftruncate.c      |    7 +++++++
 cpukit/libfs/src/defaults/default_ioctl.c          |    7 +++++++
 .../libfs/src/defaults/default_lock_and_unlock.c   |    7 +++++++
 cpukit/libfs/src/defaults/default_lseek.c          |    7 +++++++
 .../libfs/src/defaults/default_lseek_directory.c   |    7 +++++++
 cpukit/libfs/src/defaults/default_lseek_file.c     |    7 +++++++
 cpukit/libfs/src/defaults/default_mknod.c          |    7 +++++++
 cpukit/libfs/src/defaults/default_mount.c          |    7 +++++++
 cpukit/libfs/src/defaults/default_rename.c         |    7 +++++++
 cpukit/libfs/src/defaults/default_symlink.c        |    7 +++++++
 cpukit/libfs/src/defaults/default_unmount.c        |    7 +++++++
 cpukit/libfs/src/defaults/default_utime.c          |    7 +++++++
 cpukit/libfs/src/defaults/default_write.c          |    7 +++++++
 20 files changed, 140 insertions(+), 0 deletions(-)

diff --git a/cpukit/libfs/src/defaults/default_are_nodes_equal.c b/cpukit/libfs/src/defaults/default_are_nodes_equal.c
index c1e7777..b20da2d 100644
--- a/cpukit/libfs/src/defaults/default_are_nodes_equal.c
+++ b/cpukit/libfs/src/defaults/default_are_nodes_equal.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System has nodes equal
+ * @ingroup LibIOFSOps File System Operations 
+ */
+
 /*
  * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/libfs/src/defaults/default_clone.c b/cpukit/libfs/src/defaults/default_clone.c
index 5224b01..576a07c 100644
--- a/cpukit/libfs/src/defaults/default_clone.c
+++ b/cpukit/libfs/src/defaults/default_clone.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System creates a child process
+ * @ingroup LibIOFSOps File System Operations  
+ */
+
 /*
  * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/libfs/src/defaults/default_eval_path.c b/cpukit/libfs/src/defaults/default_eval_path.c
index e639f99..868d2e5 100644
--- a/cpukit/libfs/src/defaults/default_eval_path.c
+++ b/cpukit/libfs/src/defaults/default_eval_path.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System evaluates relative pathname to absolute
+ * @ingroup LibIOFSOps File System Operations 
+ */
+
 /*
  * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/libfs/src/defaults/default_fsmount.c b/cpukit/libfs/src/defaults/default_fsmount.c
index 924ba31..b505142 100644
--- a/cpukit/libfs/src/defaults/default_fsmount.c
+++ b/cpukit/libfs/src/defaults/default_fsmount.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System Mounts
+ * @ingroup LibIOFSOps File System Operations  
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_fstat.c b/cpukit/libfs/src/defaults/default_fstat.c
index 42b7339..e12d8c0 100644
--- a/cpukit/libfs/src/defaults/default_fstat.c
+++ b/cpukit/libfs/src/defaults/default_fstat.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System gets file status
+ * @ingroup LibIOFSOps File System Operations  
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_fsync.c b/cpukit/libfs/src/defaults/default_fsync.c
index 276c059..53dce0c 100644
--- a/cpukit/libfs/src/defaults/default_fsync.c
+++ b/cpukit/libfs/src/defaults/default_fsync.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System Synchronises changes to a file
+ * @ingroup LibIOFSOps File System Operations 
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_fsync_success.c b/cpukit/libfs/src/defaults/default_fsync_success.c
index 591527e..1d02e82 100644
--- a/cpukit/libfs/src/defaults/default_fsync_success.c
+++ b/cpukit/libfs/src/defaults/default_fsync_success.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default Filesystem succeeds synchronizing file's in-core state
+ * @ingroup LibIOFSOps File System Operations 
+ */
+
 /*
  * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/libfs/src/defaults/default_ftruncate.c b/cpukit/libfs/src/defaults/default_ftruncate.c
index 2455a7b..8016956 100644
--- a/cpukit/libfs/src/defaults/default_ftruncate.c
+++ b/cpukit/libfs/src/defaults/default_ftruncate.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System Truncates a file to indicated length
+ * @ingroup LibIOFSOps File System Operations  
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_ioctl.c b/cpukit/libfs/src/defaults/default_ioctl.c
index edd1c62..f9e9a9c 100644
--- a/cpukit/libfs/src/defaults/default_ioctl.c
+++ b/cpukit/libfs/src/defaults/default_ioctl.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System controls a STREAMS device
+ * @ingroup LibIOFSOps File System Operations 
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_lock_and_unlock.c b/cpukit/libfs/src/defaults/default_lock_and_unlock.c
index a88a99d..2efcdba 100644
--- a/cpukit/libfs/src/defaults/default_lock_and_unlock.c
+++ b/cpukit/libfs/src/defaults/default_lock_and_unlock.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System locks and unlocks rtems filesystem
+ * @ingroup LibIOFSOps File System Operations 
+ */
+
 /*
  * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/libfs/src/defaults/default_lseek.c b/cpukit/libfs/src/defaults/default_lseek.c
index 5af3555..2dc2e65 100644
--- a/cpukit/libfs/src/defaults/default_lseek.c
+++ b/cpukit/libfs/src/defaults/default_lseek.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System reposits the read/write file offset
+ * @ingroup LibIOFSOps File System Operations  
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_lseek_directory.c b/cpukit/libfs/src/defaults/default_lseek_directory.c
index e50eefd..15ac19a 100644
--- a/cpukit/libfs/src/defaults/default_lseek_directory.c
+++ b/cpukit/libfs/src/defaults/default_lseek_directory.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System reposits read/write file offset directory
+ * @ingroup LibIOFSOps File System Operations 
+ */
+
 /*
  * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/libfs/src/defaults/default_lseek_file.c b/cpukit/libfs/src/defaults/default_lseek_file.c
index 9d80b2a..cafc4dc 100644
--- a/cpukit/libfs/src/defaults/default_lseek_file.c
+++ b/cpukit/libfs/src/defaults/default_lseek_file.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System reposits the offset of the open file fd
+ * @ingroup LibIOFSOps File System Operations 
+ */
+
 /*
  * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/libfs/src/defaults/default_mknod.c b/cpukit/libfs/src/defaults/default_mknod.c
index 2527cc8..9a6ce7c 100644
--- a/cpukit/libfs/src/defaults/default_mknod.c
+++ b/cpukit/libfs/src/defaults/default_mknod.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System creates a special or ordinary file
+ * @ingroup LibIOFSOps File System Operations  
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_mount.c b/cpukit/libfs/src/defaults/default_mount.c
index 24c164d..902f118 100644
--- a/cpukit/libfs/src/defaults/default_mount.c
+++ b/cpukit/libfs/src/defaults/default_mount.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System mounts a filesystem
+ * @ingroup LibIOFSOps File System Operations  
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_rename.c b/cpukit/libfs/src/defaults/default_rename.c
index c3b1a5a..5b5bafa 100644
--- a/cpukit/libfs/src/defaults/default_rename.c
+++ b/cpukit/libfs/src/defaults/default_rename.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTESM Default File System Rename Files
+ * @ingroup LibIOFSOps File System Operations  
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_symlink.c b/cpukit/libfs/src/defaults/default_symlink.c
index 0652fc0..55852ab 100644
--- a/cpukit/libfs/src/defaults/default_symlink.c
+++ b/cpukit/libfs/src/defaults/default_symlink.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System creates a symbolic link to a file
+ * @ingroup LibIOFSOps File System Operations 
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_unmount.c b/cpukit/libfs/src/defaults/default_unmount.c
index b4820b9..de520c1 100644
--- a/cpukit/libfs/src/defaults/default_unmount.c
+++ b/cpukit/libfs/src/defaults/default_unmount.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System Unmounts
+ * @ingroup LibIOFSOps File System Operations 
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_utime.c b/cpukit/libfs/src/defaults/default_utime.c
index 5d1dd82..f9ec57c 100644
--- a/cpukit/libfs/src/defaults/default_utime.c
+++ b/cpukit/libfs/src/defaults/default_utime.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System sets file access and modification times
+ * @ingroup LibIOFSOps File System Operations  
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libfs/src/defaults/default_write.c b/cpukit/libfs/src/defaults/default_write.c
index 7328c81..c5aff4b 100644
--- a/cpukit/libfs/src/defaults/default_write.c
+++ b/cpukit/libfs/src/defaults/default_write.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Default File System sends a message to another user
+ * @ingroup LibIOFSOps File System Operations 
+ */
+
 /*
  *  COPYRIGHT (c) 2010.
  *  On-Line Applications Research Corporation (OAR).




More information about the vc mailing list