Changeset 783 for firmware/trunk/libraries/digitalin/digitalin.c

Timestamp:

08/05/08 21:42:47 (5 months ago)

Author:

liamstask

Message:

- revamp doc for digitalin

Files:

• firmware/trunk/libraries/digitalin/digitalin.c (modified) (4 diffs)

firmware/trunk/libraries/digitalin/digitalin.c

@@ -55 +55 @@
 
 /** \defgroup DigitalIn Digital Inputs
-* The Digital In subsystem reads the 8 inputs on the Make Controller as digital values - 1 (on) or 0 (off).  
-  The 8 inputs can be either read as digital inputs by DigitalIn or as \ref AnalogIn.
+* Read the 8 inputs on the Make Controller as digital values - 1 (on) or 0 (off).  
+  The 8 inputs can be either read as digital inputs by DigitalIn or as \ref AnalogIn.  
+  Because inputs 4-7 are actually AnalogIn lines, there's no performance gain to reading
+  those as DigitalIns.
 * \ingroup Libraries
 * @{
@@ -66 +68 @@
   @param state An integer specifying the state - 1 (active) or 0 (inactive).
   @return Zero on success.
+  
+  \b Example
+  \code
+  // Enable DigitalIn 3
+  DigitalIn_SetActive(3, 1);
+  \endcode
 */
 int DigitalIn_SetActive( int index, int state )
@@ -82 +90 @@
   @param index An integer specifying which Digital In (0-7).
   @return Zero if inactive, non-zero if active.
+  
+  \b Example
+  \code
+  if( DigitalIn_GetActive(3) )
+  {
+    // DigitalIn 3 is active
+  }
+  else
+  {
+    // DigitalIn 3 is inactive
+  }
+  \endcode
 */
 int DigitalIn_GetActive( int index )
@@ -94 +114 @@
   If the voltage on the input is greater than ~0.6V, the Digital In will read high.
   @param index An integer specifying which Digital In (0-7).
-  @return The value - 1 (high) or 0 (low).
+  @return Non-zero when high, 0 when low
+  
+  \b Example
+  \code
+  if( DigitalIn_GetValue(5) )
+  {
+    // DigitalIn 5 is high
+  }
+  else
+  {
+    // DigitalIn 5 is low
+  }
+  \endcode
 */
 int DigitalIn_GetValue( int index )