summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/types.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2010-08-09 08:59:57 +0000
committerSebastian Huber <sebastian.huber@embedded-brains.de>2010-08-09 08:59:57 +0000
commite5a2eb4d32432123c01ce8b8d2225abc43799a70 (patch)
tree5c7f155c1a05f8d9066445febc8de1a140bd9560 /cpukit/rtems/include/rtems/rtems/types.h
parent2010-08-09 Sebastian Huber <sebastian.huber@embedded-brains.de> (diff)
downloadrtems-e5a2eb4d32432123c01ce8b8d2225abc43799a70.tar.bz2
2010-08-09 Sebastian Huber <sebastian.huber@embedded-brains.de>
* rtems/include/rtems.h, rtems/mainpage.h, rtems/include/rtems/rtems/types.h: Documentation.
Diffstat (limited to '')
-rw-r--r--cpukit/rtems/include/rtems/rtems/types.h13
1 files changed, 8 insertions, 5 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/types.h b/cpukit/rtems/include/rtems/rtems/types.h
index eecc019e68..2ceeeaa203 100644
--- a/cpukit/rtems/include/rtems/rtems/types.h
+++ b/cpukit/rtems/include/rtems/rtems/types.h
@@ -69,16 +69,17 @@ typedef boolean rtems_boolean;
#endif
/**
- * @brief Classic API object name Type.
+ * @brief Classic API @ref ClassicRTEMSSubSecObjectNames "object name" type.
*
- * Contains the name of a Classic API object. It is an unsigned 32 bit integer
+ * Contains the name of a Classic API object. It is an unsigned 32-bit integer
* which can be treated as a numeric value or initialized using
* rtems_build_name() to contain four ASCII characters.
*/
typedef uint32_t rtems_name;
/**
- * @brief Used to manage and manipulate RTEMS object identifier.
+ * @brief Used to manage and manipulate
+ * @ref ClassicRTEMSSubSecObjectIdentifiers "RTEMS object identifiers".
*/
typedef Objects_Id rtems_id;
@@ -116,7 +117,8 @@ typedef CPU_Interrupt_frame rtems_interrupt_frame;
typedef Heap_Information_block region_information_block;
/**
- * @brief Used to manage and manipulate intervals specified by clock ticks.
+ * @brief Used to manage and manipulate intervals specified by
+ * @ref ClassicRTEMSSecTime "clock ticks".
*/
typedef Watchdog_Interval rtems_interval;
@@ -133,7 +135,8 @@ typedef Watchdog_Interval rtems_interval;
#endif
/**
- * @brief Data structure to manage and manipulate calendar time.
+ * @brief Data structure to manage and manipulate calendar
+ * @ref ClassicRTEMSSecTime "time".
*/
typedef struct {
/**