From a1f9934a8f096489620362620ef610b52a3c4ae1 Mon Sep 17 00:00:00 2001
From: Mathew Kallada <matkallada@gmail.com>
Date: Fri, 4 Jan 2013 09:01:21 -0600
Subject: score: Doxygen Clean Up Task #3

---
 cpukit/score/include/rtems/score/smplock.h | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

(limited to 'cpukit/score/include/rtems/score/smplock.h')

diff --git a/cpukit/score/include/rtems/score/smplock.h b/cpukit/score/include/rtems/score/smplock.h
index 611b49811f..1f1c992628 100644
--- a/cpukit/score/include/rtems/score/smplock.h
+++ b/cpukit/score/include/rtems/score/smplock.h
@@ -1,6 +1,8 @@
 /**
  *  @file  rtems/score/smplock.h
  *
+ *  @brief Interface for Atomic Locks
+ *
  *  This include file defines the interface for atomic locks
  *  which can be used in multiprocessor configurations.
  */
@@ -54,7 +56,7 @@ typedef struct {
 } SMP_lock_spinlock_nested_Control;
 
 /**
- *  @brief Initialize a Lock
+ *  @brief Initialize a lock.
  *
  *  This method is used to initialize the lock at @a lock.
  *
@@ -65,13 +67,13 @@ void _SMP_lock_spinlock_simple_Initialize(
 );
 
 /**
- *  @brief Obtain a Lock
+ *  @brief Obtain a lock.
  *
  *  This method is used to obtain the lock at @a lock.
  *
  *  @param [in] lock is the address of the lock to obtain.
  *
- *  @return This method returns with processor interrupts disabled.
+ *  @retval This method returns with processor interrupts disabled.
  *          The previous level is returned.
  */
 ISR_Level _SMP_lock_spinlock_simple_Obtain(
@@ -79,7 +81,7 @@ ISR_Level _SMP_lock_spinlock_simple_Obtain(
 );
 
 /**
- *  @brief Release a Lock
+ *  @brief Release a lock.
  *
  *  This method is used to release the lock at @a lock.
  *
@@ -91,7 +93,7 @@ void _SMP_lock_spinlock_simple_Release(
 );
 
 /**
- *  @brief Initialize a Lock
+ *  @brief Initialize a lock.
  *
  *  This method is used to initialize the lock at @a lock.
  *
@@ -102,7 +104,7 @@ void _SMP_lock_spinlock_nested_Initialize(
 );
 
 /**
- *  @brief Obtain a Lock
+ *  @brief Obtain a lock.
  *
  *  This method is used to obtain the lock at @a lock.  ISR's are
  *  disabled when this routine returns and it is the callers responsibility
@@ -115,7 +117,7 @@ void _SMP_lock_spinlock_nested_Initialize(
  *
  *  @param [in] lock is the address of the lock to obtain.
  *
- *  @return This method returns with processor interrupts disabled.
+ *  @retval This method returns with processor interrupts disabled.
  *          The previous level is returned.
  */
 ISR_Level _SMP_lock_spinlock_nested_Obtain(
@@ -123,9 +125,9 @@ ISR_Level _SMP_lock_spinlock_nested_Obtain(
 );
 
 /**
- *  @brief Release a Lock
+ *  @brief Release a lock.
  *
- *  This method is used to release the lock at @a lock.  
+ *  This method is used to release the lock at @a lock.
  *
  *  @note ISR's are reenabled by this method and are expected to be
  *  disabled upon entry to the method.
@@ -144,4 +146,4 @@ void _SMP_lock_spinlock_nested_Release(
 /**@}*/
 
 #endif
-/* end of include file */
+/* end of include file */
\ No newline at end of file
-- 
cgit v1.2.3