From 27a1a6a19b3feb3b04c16a82134a6aec1cef93d7 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Fri, 24 Jun 2011 17:50:31 +0000 Subject: 2011-06-24 Joel Sherrill * Doxyfile.in, score/include/rtems/score/apimutex.h, score/include/rtems/score/basedefs.h, score/include/rtems/score/coremsg.h, score/include/rtems/score/object.h: Fix some Doxygen warnings. --- cpukit/score/include/rtems/score/apimutex.h | 16 +++++++++++ cpukit/score/include/rtems/score/basedefs.h | 42 ++++++++++++++++------------- cpukit/score/include/rtems/score/coremsg.h | 14 ++++++++++ cpukit/score/include/rtems/score/object.h | 6 +++++ 4 files changed, 60 insertions(+), 18 deletions(-) (limited to 'cpukit/score') diff --git a/cpukit/score/include/rtems/score/apimutex.h b/cpukit/score/include/rtems/score/apimutex.h index 691f60b709..8a0ad124e7 100644 --- a/cpukit/score/include/rtems/score/apimutex.h +++ b/cpukit/score/include/rtems/score/apimutex.h @@ -98,11 +98,27 @@ void _API_Mutex_Unlock( API_Mutex_Control *mutex ); * @{ */ +/** + * @brief Memory Allocation Mutex + * + * This points to the API Mutex instance used to ensure that only + * one thread at a time is allocating or freeing memory. + */ SCORE_EXTERN API_Mutex_Control *_RTEMS_Allocator_Mutex; +/** + * @brief Macro to Ease Locking the Allocator Mutex + * + * This macro makes it explicit that one is locking the allocator mutex. + */ #define _RTEMS_Lock_allocator() \ _API_Mutex_Lock( _RTEMS_Allocator_Mutex ) +/** + * @brief Macro to Ease Unlocking the Allocator Mutex + * + * This macro makes it explicit that one is unlocking the allocator mutex. + */ #define _RTEMS_Unlock_allocator() \ _API_Mutex_Unlock( _RTEMS_Allocator_Mutex ) diff --git a/cpukit/score/include/rtems/score/basedefs.h b/cpukit/score/include/rtems/score/basedefs.h index b956806313..91774e4fec 100644 --- a/cpukit/score/include/rtems/score/basedefs.h +++ b/cpukit/score/include/rtems/score/basedefs.h @@ -31,10 +31,16 @@ #endif #ifndef TRUE + /** + * This ensures that RTEMS has TRUE defined in all situations. + */ #define TRUE 1 #endif #ifndef FALSE + /** + * This ensures that RTEMS has FALSE defined in all situations. + */ #define FALSE 0 #endif @@ -49,11 +55,11 @@ * referenced as "external" in every other file. */ #ifdef SCORE_INIT -#undef SCORE_EXTERN -#define SCORE_EXTERN + #undef SCORE_EXTERN + #define SCORE_EXTERN #else -#undef SCORE_EXTERN -#define SCORE_EXTERN extern + #undef SCORE_EXTERN + #define SCORE_EXTERN extern #endif /** @@ -63,11 +69,11 @@ * referenced as "external" in every other file. */ #ifdef SAPI_INIT -#undef SAPI_EXTERN -#define SAPI_EXTERN + #undef SAPI_EXTERN + #define SAPI_EXTERN #else -#undef SAPI_EXTERN -#define SAPI_EXTERN extern + #undef SAPI_EXTERN + #define SAPI_EXTERN extern #endif /** @@ -77,11 +83,11 @@ * referenced as "external" in every other file. */ #ifdef RTEMS_API_INIT -#undef RTEMS_EXTERN -#define RTEMS_EXTERN + #undef RTEMS_EXTERN + #define RTEMS_EXTERN #else -#undef RTEMS_EXTERN -#define RTEMS_EXTERN extern + #undef RTEMS_EXTERN + #define RTEMS_EXTERN extern #endif /** @@ -91,11 +97,11 @@ * referenced as "external" in every other file. */ #ifdef POSIX_API_INIT -#undef POSIX_EXTERN -#define POSIX_EXTERN + #undef POSIX_EXTERN + #define POSIX_EXTERN #else -#undef POSIX_EXTERN -#define POSIX_EXTERN extern + #undef POSIX_EXTERN + #define POSIX_EXTERN extern #endif /** @@ -105,9 +111,9 @@ * type checking with no cost in code size or execution speed. */ #ifdef __GNUC__ -# define RTEMS_INLINE_ROUTINE static __inline__ + #define RTEMS_INLINE_ROUTINE static __inline__ #else -# define RTEMS_INLINE_ROUTINE static inline + #define RTEMS_INLINE_ROUTINE static inline #endif /** diff --git a/cpukit/score/include/rtems/score/coremsg.h b/cpukit/score/include/rtems/score/coremsg.h index b43e670226..227a94cdf2 100644 --- a/cpukit/score/include/rtems/score/coremsg.h +++ b/cpukit/score/include/rtems/score/coremsg.h @@ -36,14 +36,28 @@ #include #if defined(RTEMS_POSIX_API) + /** + * This macro is defined when an API is enabled that requires that the + * Message Queue Handler include support for priority based enqueuing + * of messages. + */ #define RTEMS_SCORE_COREMSG_ENABLE_MESSAGE_PRIORITY #endif #if defined(RTEMS_POSIX_API) + /** + * This macro is defined when an API is enabled that requires that the + * Message Queue Handler include support for notification of enqueuing + * a message. + */ #define RTEMS_SCORE_COREMSG_ENABLE_NOTIFICATION #endif #if defined(RTEMS_POSIX_API) + /** + * This macro is defined when an API is enabled that requires the + * Message Queue Handler include support for blocking send operations. + */ #define RTEMS_SCORE_COREMSG_ENABLE_BLOCKING_SEND #endif diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h index 590d831345..d7864830a3 100644 --- a/cpukit/score/include/rtems/score/object.h +++ b/cpukit/score/include/rtems/score/object.h @@ -26,6 +26,12 @@ #include #if defined(RTEMS_POSIX_API) + /** + * This macro is defined when an API is enabled that requires the + * use of strings for object names. Since the Classic API uses + * 32-bit unsigned integers and not strings, this allows us to + * disable this in the smallest RTEMS configuratinos. + */ #define RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES #endif -- cgit v1.2.3