[1/1] cpukit/libfs Doxygen Enhancement Task #4
Cynthia Rempel
cynt6007 at vandals.uidaho.edu
Sun Dec 23 20:26:35 UTC 2012
Hi,
Could someone please submit this patch?
The purpose of this patch is to add Doxygen comments to
cpukit/libfs/src/defaults/default_fsmount.c
cpukit/libfs/src/defaults/default_lseek.c
cpukit/libfs/src/defaults/default_lseek_directory.c
cpukit/libfs/src/defaults/default_symlink.c
cpukit/libfs/src/defaults/default_mknod.c
cpukit/libfs/src/defaults/default_ftruncate.c
cpukit/libfs/src/defaults/default_unmount.c
cpukit/libfs/src/defaults/default_fsync_success.c
cpukit/libfs/src/defaults/default_eval_path.c
cpukit/libfs/src/defaults/default_fsync.c
cpukit/libfs/src/defaults/default_are_nodes_equal.c
cpukit/libfs/src/defaults/default_lseek_file.c
cpukit/libfs/src/defaults/default_utime.c
cpukit/libfs/src/defaults/default_lock_and_unlock.c
cpukit/libfs/src/defaults/default_ioctl.c
cpukit/libfs/src/defaults/default_write.c
cpukit/libfs/src/defaults/default_clone.c
cpukit/libfs/src/defaults/default_fstat.c
cpukit/libfs/src/defaults/default_rename.c
cpukit/libfs/src/defaults/default_mount.c
This patch is compliant with the ADDING Doxygen headers task
http://www.rtems.org/wiki/index.php/GoogleCodeInProjects#Add_Doxygen_File_Headers
which simply has the headers added with A sentence, as opposed to the FIXING Doxygen headers task
http://www.rtems.org/wiki/index.php/GoogleCodeInProjects#Fix_Comment_Block_at_Top_of_Header_Files
which has the sentence changed from a Table of Contents format to a Topic Sentence format.
Thanks!
diff --git a/cpukit/libfs/src/defaults/default_are_nodes_equal.c b/cpukit/libfs/src/defaults/default_are_nodes_equal.c
index c1e7777..47d7b82 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..6d33101 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..7d4c397 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..09dacb2 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..56d1564 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..cc344bb 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..e409e3c 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..921882c 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..a87d89b 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..1a6bd65 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..20e9583 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..de11846 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..88bb245 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..cd54b09 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..24ec0bc 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..86a4ef6 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..75e0f14 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..806f111 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..d3bc6b9 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..6e36a34 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 devel
mailing list