summaryrefslogtreecommitdiffstats
path: root/cpukit/libfs/src/rfs/rtems-rfs-trace.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2013-01-08 09:02:58 -0500
committerGedare Bloom <gedare@rtems.org>2013-01-08 09:02:58 -0500
commite354eb4f4fbd602adede59138c819eb94e7c1488 (patch)
tree50a219aab9a9d69d1e53bf45f38ff15476dd0b0c /cpukit/libfs/src/rfs/rtems-rfs-trace.h
parentsapi: Doxygen Clean Up Task #1 (diff)
downloadrtems-e354eb4f4fbd602adede59138c819eb94e7c1488.tar.bz2
libfs: Doxygen Clean Up Task #1
http://www.google-melange.com/gci/task/view/google/gci2012/8120204 Patch committed with fixes for whitespace issues.
Diffstat (limited to 'cpukit/libfs/src/rfs/rtems-rfs-trace.h')
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-trace.h16
1 files changed, 10 insertions, 6 deletions
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-trace.h b/cpukit/libfs/src/rfs/rtems-rfs-trace.h
index 09273a5939..030e6c2058 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-trace.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-trace.h
@@ -1,7 +1,8 @@
/**
* @file
*
- * @brief Manages the Trace and Debugging Features of the RTEMS RFS File System
+ * @brief Manages the Trace and Debugging Features of the
+ * RTEMS RFS File System
*
* @ingroup rtems-rfs
*
@@ -87,7 +88,8 @@ typedef uint64_t rtems_rfs_trace_mask;
* Call to check if this part is bring traced. If RTEMS_RFS_TRACE is defined to
* 0 the code is dead code elminiated when built with -Os, -O2, or higher.
*
- * @param mask The part of the API to trace.
+ * @param[in] mask is the part of the API to trace.
+ *
* @retval true Tracing is active for the mask.
* @retval false Do not trace.
*/
@@ -100,8 +102,9 @@ bool rtems_rfs_trace (rtems_rfs_trace_mask mask);
/**
* Set the mask.
*
- * @param mask The mask bits to set.
- * @return The previous mask.
+ * @param[in] mask are the mask bits to set.
+ *
+ * @retval mask The previous mask.
*/
#if RTEMS_RFS_TRACE
rtems_rfs_trace_mask rtems_rfs_trace_set_mask (rtems_rfs_trace_mask mask);
@@ -112,8 +115,9 @@ rtems_rfs_trace_mask rtems_rfs_trace_set_mask (rtems_rfs_trace_mask mask);
/**
* Clear the mask.
*
- * @param mask The mask bits to clear.
- * @return The previous mask.
+ * @param[in] mask are the mask bits to clear.
+ *
+ * @retval mask The previous mask.
*/
#if RTEMS_RFS_TRACE
rtems_rfs_trace_mask rtems_rfs_trace_clear_mask (rtems_rfs_trace_mask mask);