[rtems commit] libcsupport: Documentation

[Sebastian Huber]

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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Jan  9 20:39:26 2013 +0100

libcsupport: Documentation

---

 cpukit/libcsupport/include/rtems/libcsupport.h |   15 +++++++++------
 1 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/cpukit/libcsupport/include/rtems/libcsupport.h b/cpukit/libcsupport/include/rtems/libcsupport.h
index 808c0fb..46a1ec4 100644
--- a/cpukit/libcsupport/include/rtems/libcsupport.h
+++ b/cpukit/libcsupport/include/rtems/libcsupport.h
@@ -141,7 +141,7 @@ typedef struct {
 /**
  * @brief Tasks a snapshot of the resource usage of the system.
  *
- * @param[out] snapshot will contain snapshot of used resources.
+ * @param[out] snapshot The snapshot of used resources.
  *
  * @see rtems_resource_snapshot_equal() and rtems_resource_snapshot_check().
  *
@@ -167,8 +167,11 @@ void rtems_resource_snapshot_take(rtems_resource_snapshot *snapshot);
 /**
  * @brief Compares two resource snapshots for equality.
  *
+ * @param[in] a One resource snapshot.
+ * @param[in] b Another resource snapshot.
+ *
  * @retval true The resource snapshots are equal.
- * @retval false The resource snapshots are not equal.
+ * @retval false Otherwise.
  *
  * @see rtems_resource_snapshot_take().
  */
@@ -179,13 +182,13 @@ bool rtems_resource_snapshot_equal(
 
 /**
  * @brief Takes a new resource snapshot and checks that it is equal to the
- * given snapshot.
+ * given resource snapshot.
  *
- * @param[in] snapshot is a pointer to the snapshot used for comparison 
- * with the new snapshot.
+ * @param[in] snapshot The resource snapshot used for comparison with the new
+ * resource snapshot.
  *
  * @retval true The resource snapshots are equal.
- * @retval false The resource snapshots are not equal.
+ * @retval false Otherwise.
  *
  * @see rtems_resource_snapshot_take().
  */