[rtems commit] libcsupport: Revert documentation changes

Sebastian Huber sebh at rtems.org
Thu Dec 13 10:29:50 UTC 2012


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Thu Dec 13 11:29:06 2012 +0100

libcsupport: Revert documentation changes

---

 cpukit/libcsupport/include/rtems/libio_.h |   18 +++++++++---------
 cpukit/libcsupport/include/rtems/malloc.h |    2 +-
 2 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h
index 19b8661..f56926a 100644
--- a/cpukit/libcsupport/include/rtems/libio_.h
+++ b/cpukit/libcsupport/include/rtems/libio_.h
@@ -62,7 +62,7 @@ extern const rtems_filesystem_file_handlers_r rtems_filesystem_null_handlers;
 extern rtems_filesystem_mount_table_entry_t rtems_filesystem_null_mt_entry;
 
 /**
- *  @brief The Global NULL Location
+ * @brief The global null location.
  *
  * Every operation and the open and fstat handlers of this location returns an
  * error status.  The errno is not touched by these operations and handlers.
@@ -194,15 +194,15 @@ void rtems_filesystem_location_clone(
 );
 
 /**
- *  @brief Returns the Type of a Node
+ * @brief Returns the type of a node.
  *
- *  This function obtains and releases the file system instance lock.
+ * This function obtains and releases the file system instance lock.
  *
- *  @param[in] loc The location of the node.
+ * @param[in] loc The location of the node.
  *
- *  @return The node type.
+ * @return The node type.
  *
- *  @see rtems_filesystem_instance_lock().
+ * @see rtems_filesystem_instance_lock().
  */
 rtems_filesystem_node_types_t rtems_filesystem_node_type(
   const rtems_filesystem_location_info_t *loc
@@ -773,10 +773,10 @@ void rtems_filesystem_eval_path_error(
 );
 
 /**
- *  @brief Checks that the Locations Exist in the Same File System Instance
+ * @brief Checks that the locations exist in the same file system instance.
  *
- *  @retval 0 The locations exist and are in the same file system instance.
- *  @retval -1 An error occured.  The @c errno indicates the error.
+ * @retval 0 The locations exist and are in the same file system instance.
+ * @retval -1 An error occured.  The @c errno indicates the error.
  */
 int rtems_filesystem_location_exists_in_same_instance_as(
   const rtems_filesystem_location_info_t *a,
diff --git a/cpukit/libcsupport/include/rtems/malloc.h b/cpukit/libcsupport/include/rtems/malloc.h
index fdb57f3..877bdbc 100644
--- a/cpukit/libcsupport/include/rtems/malloc.h
+++ b/cpukit/libcsupport/include/rtems/malloc.h
@@ -222,7 +222,7 @@ rtems_status_code rtems_heap_extend(
 );
 
 /**
- *  @brief Greedy Allocate that Empties the Heap
+ * @brief Greedy allocate that empties the heap.
  *
  * Afterward the heap has at most @a block_count allocatable blocks of sizes
  * specified by @a block_sizes.  The @a block_sizes must point to an array with




More information about the vc mailing list