[rtems commit] score: Documentation

[Sebastian Huber]

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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed May  7 08:13:44 2014 +0200

score: Documentation

---

 cpukit/rtems/include/rtems/rtems/intr.h    |    8 ++++++--
 cpukit/score/include/rtems/score/isrlock.h |    8 ++++++--
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/cpukit/rtems/include/rtems/rtems/intr.h b/cpukit/rtems/include/rtems/rtems/intr.h
index 7365227..57e8a96 100644
--- a/cpukit/rtems/include/rtems/rtems/intr.h
+++ b/cpukit/rtems/include/rtems/rtems/intr.h
@@ -166,6 +166,9 @@ typedef ISR_lock_Context rtems_interrupt_lock_context;
 
 /**
  * @brief Initializer for static initialization of interrupt locks.
+ *
+ * @param _name The name for the interrupt lock.  It must be a string.  The
+ * name is only used if profiling is enabled.
  */
 #define RTEMS_INTERRUPT_LOCK_INITIALIZER( _name ) ISR_LOCK_INITIALIZER( _name )
 
@@ -175,8 +178,9 @@ typedef ISR_lock_Context rtems_interrupt_lock_context;
  * Concurrent initialization leads to unpredictable results.
  *
  * @param[in,out] _lock The interrupt lock.
- * @param[in] _name The name for the interrupt lock.  This name must be
- * persistent throughout the life time of this lock.
+ * @param[in] _name The name for the interrupt lock.  This name must be a
+ * string persistent throughout the life time of this lock.  The name is only
+ * used if profiling is enabled.
  */
 #define rtems_interrupt_lock_initialize( _lock, _name ) \
   _ISR_lock_Initialize( _lock, _name )
diff --git a/cpukit/score/include/rtems/score/isrlock.h b/cpukit/score/include/rtems/score/isrlock.h
index d36b604..80a8a0b 100644
--- a/cpukit/score/include/rtems/score/isrlock.h
+++ b/cpukit/score/include/rtems/score/isrlock.h
@@ -69,6 +69,9 @@ typedef struct {
 
 /**
  * @brief Initializer for static initialization of ISR locks.
+ *
+ * @param _name The name for the interrupt lock.  It must be a string.  The
+ * name is only used if profiling is enabled.
  */
 #if defined( RTEMS_SMP )
   #define ISR_LOCK_INITIALIZER( name ) \
@@ -84,8 +87,9 @@ typedef struct {
  * Concurrent initialization leads to unpredictable results.
  *
  * @param[in,out] lock The ISR lock control.
- * @param[in] name The name for the ISR lock.  This name must be persistent
- * throughout the life time of this lock.
+ * @param[in] _name The name for the ISR lock.  This name must be a
+ * string persistent throughout the life time of this lock.  The name is only
+ * used if profiling is enabled.
  */
 static inline void _ISR_lock_Initialize(
   ISR_lock_Control *lock,