2009-08-05 Sebastian Huber <sebastian.huber@embedded-brains.de>

	* libcsupport/include/rtems/libio_.h,
	libcsupport/src/fs_null_handlers.c: Null handlers are now const.
	* libi2c/libi2c.c, libi2c/libi2c.h: Documentation. Do not create
	semaphores on the fly.
	* cpukit/libblock/src/bdpart.c: Fixed format specifier.
	* cpukit/libblock/include/rtems/bdbuf.h, rtems/include/rtems.h,
	rtems/include/rtems/rtems/asr.h, rtems/include/rtems/rtems/attr.h,
	rtems/include/rtems/rtems/barrier.h,
	rtems/include/rtems/rtems/barriermp.h,
	rtems/include/rtems/rtems/cache.h, rtems/include/rtems/rtems/clock.h,
	rtems/include/rtems/rtems/config.h, rtems/include/rtems/rtems/dpmem.h,
	rtems/include/rtems/rtems/event.h,
	rtems/include/rtems/rtems/eventmp.h,
	rtems/include/rtems/rtems/eventset.h,
	rtems/include/rtems/rtems/intr.h, rtems/include/rtems/rtems/message.h,
	rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h,
	rtems/include/rtems/rtems/msgmp.h, rtems/include/rtems/rtems/object.h,
	rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h,
	rtems/include/rtems/rtems/ratemon.h,
	rtems/include/rtems/rtems/region.h,
	rtems/include/rtems/rtems/regionmp.h,
	rtems/include/rtems/rtems/rtemsapi.h, rtems/include/rtems/rtems/sem.h,
	rtems/include/rtems/rtems/semmp.h, rtems/include/rtems/rtems/signal.h,
	rtems/include/rtems/rtems/signalmp.h,
	rtems/include/rtems/rtems/status.h,
	rtems/include/rtems/rtems/support.h,
	rtems/include/rtems/rtems/taskmp.h, rtems/include/rtems/rtems/tasks.h,
	rtems/include/rtems/rtems/timer.h, rtems/include/rtems/rtems/types.h,
	rtems/inline/rtems/rtems/support.inl: Documentation.
	* include/rtems/irq-extension.h: Documentation. Added API for
	interrupt servers.

1 files changed, 39 insertions, 33 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/support.h b/cpukit/rtems/include/rtems/rtems/support.h
index 8d8a85a825..220411d984 100644
--- a/cpukit/rtems/include/rtems/rtems/support.h
+++ b/cpukit/rtems/include/rtems/rtems/support.h
@@ -1,8 +1,11 @@
 /**
- * @file rtems/rtems/support.h
+ * @file
  *
- *  This include file contains information about support functions for
- *  the RTEMS API.
+ * @ingroup ClassicRTEMS
+ *
+ * @ingroup ClassicRTEMSWorkspace
+ *
+ * @brief Classic API support.
  */
 
 /*  COPYRIGHT (c) 1989-2008.
@@ -25,58 +28,61 @@ extern "C" {
 #include <rtems/rtems/types.h>
 
 /**
- *  @addtogroup ClassicRTEMS
- *  @{
+ * @addtogroup ClassicRTEMS
+ *
+ * @{
  */
 
 /**
- *  @brief milliseconds to microseconds
- *
- *  This is the public milliseconds to microseconds conversion.
+ * @brief Returns the number of micro seconds for the milli seconds value @a _ms.
  */
 #define RTEMS_MILLISECONDS_TO_MICROSECONDS(_ms) \
         TOD_MILLISECONDS_TO_MICROSECONDS(_ms)
 
 /**
- *  @brief milliseconds to ticks
- *
- *  This is the public milliseconds to ticks conversion.
+ * @brief Returns the number of ticks for the milli seconds value @a _ms.
  */
 #define RTEMS_MILLISECONDS_TO_TICKS(_ms) \
        (TOD_MILLISECONDS_TO_MICROSECONDS(_ms) / \
           rtems_configuration_get_microseconds_per_tick())
 
 /**
- *  @brief microseconds to ticks
- *
- *  This is the public microseconds to tick conversion.
+ * @brief Returns the number of ticks for the micro seconds value @a _us.
  */
-#define RTEMS_MICROSECONDS_TO_TICKS(_ms) \
-       ((_ms) / rtems_configuration_get_microseconds_per_tick())
+#define RTEMS_MICROSECONDS_TO_TICKS(_us) \
+       ((_us) / rtems_configuration_get_microseconds_per_tick())
+
+/** @} */
 
 /**
- *  @brief get workspace information
+ * @defgroup ClassicRTEMSWorkspace Workspace
  *
- *  This returns information about the heap that is used as
- *  the RTEMS Executive Workspace.
+ * @ingroup ClassicRTEMS
  *
- *  @param[in] the_info
+ * Workspace definitions.
  *
- *  @return true if successful
+ * @{
+ */
+
+/**
+ * @brief Gets workspace information.
+ *
+ * Returns information about the heap that is used as the RTEMS Executive
+ * Workspace in @a the_info.
+ *
+ * Returns @c true if successful, and @a false otherwise.
  */
 bool rtems_workspace_get_information(
   Heap_Information_block  *the_info
 );
 
 /**
- *  @brief allocate memory from workspace
+ * @brief Allocates memory from the workspace.
  *
- *  This allocates memory from the the RTEMS Executive Workspace.
+ * A number of @a bytes bytes will be allocated from the RTEMS Executive
+ * Workspace and returned in @a pointer.
  *
- *  @param[in] bytes is the number of bytes to allocate 
- *  @param[in] pointer is the returned pointer to allocated memory
- *
- *  @return true if successful
+ * Returns @c true if successful, and @a false otherwise.
  */
 bool rtems_workspace_allocate(
   size_t   bytes,
@@ -84,19 +90,19 @@ bool rtems_workspace_allocate(
 );
 
 /**
- * @brief free memory back to the workspace
- *
- *  This frees memory that was allocated from   
- *  the RTEMS Executive Workspace.
+ * @brief Frees memory allocated from the workspace.
  *
- *  @param[in] pointer is the allocated workspace
+ * This frees the memory indicated by @a pointer that was allocated from the
+ * RTEMS Executive Workspace.
  *
- *  @return true if successful
+ * Returns @c true if successful, and @a false otherwise.
  */
 bool rtems_workspace_free(
   void *pointer
 );
 
+/** @} */
+
 #ifndef __RTEMS_APPLICATION__
 #include <rtems/rtems/support.inl>
 #endif