Changeset 782

Timestamp:

08/05/08 21:34:59 (4 months ago)

Author:

liamstask

Message:

- revamp AppLed? doc

Files:

• firmware/trunk/libraries/appled/appled.c (modified) (5 diffs)

firmware/trunk/libraries/appled/appled.c

@@ -63 +63 @@
 
 /**
-  Attempts to gain access to the I/O lines associated the given LED.
+  Enable an LED in the AppLed subsystem.
   @param index An integer specifying which LED (0-3).
   @param state An integer specifying locked/active (1) or unlocked/inactive (0).
   @return Zero on success.
+  
+  \b Example
+  \code
+  // enable LED 0
+  AppLed_SetActive(0, 1);
+  \endcode
 */
 int AppLed_SetActive( int index, int state )
@@ -80 +86 @@
 
 /**
-  Returns whether the I/O lines associated with the LED are available.
+  Read whether an AppLed is enabled.
   @param index An integer specifying which LED (0-3).
   @return Zero if available, otherwise non-zero.
+  
+  \b Example
+  \code
+  if(AppLed_GetActive(1))
+  {
+    // LED 1 is enabled
+  }
+  else
+  {
+    // LED 1 is not enabled
+  }
+  \endcode
 */
 int AppLed_GetActive( int index )
@@ -92 +110 @@
 
 /** 
-  Control an LED on the Application Board.
+  Turn an LED on or off.
   Sets whether the specified LED on the Application Board is on or off.
   @param index an integer specifying which LED (0-3).
@@ -98 +116 @@
   @return Zero on success, otherwise error code.
 
-  \par Example
+  \b Example
   \code
   // turn on LED 2
@@ -128 +146 @@
 
 /** 
-  Read the state of an LED on the Application Board.
+  Read whether an LED is on or off.
   @param index An integer specifying which LED (0-3).
   @return the LED state, or zero on error.
+  
+  \b Example
+  \code
+  if(AppLed_GetState(2))
+  {
+    // LED 2 is currently on
+  }
+  else
+  {
+    // LED 2 is currently off
+  }
+  \endcode
 */
 int AppLed_GetState( int index )