libfs: Doxygen Enhancement Task #4

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 c1e7777c40..b20da2de23 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 5224b01d19..576a07ce03 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 e639f9985c..868d2e5769 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 924ba313fc..b505142746 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 42b7339e0b..e12d8c0fe0 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 276c059bb5..53dce0c260 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 591527e3e8..1d02e82b29 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 2455a7b9f2..8016956ecb 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 edd1c622ba..f9e9a9cf29 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 a88a99d4a5..2efcdba6e5 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 5af355513e..2dc2e654ac 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 e50eefd667..15ac19a5a3 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 9d80b2a176..cafc4dcf76 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 2527cc89b8..9a6ce7cc16 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 24c164dd8e..902f1182b3 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 c3b1a5a0d3..5b5bafaf08 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 0652fc03a1..55852abb05 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 b4820b9410..de520c1033 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 5d1dd82a04..f9ec57c41a 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 7328c81eb7..c5aff4b534 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).