Diff: include/Lib17_DIO.h

Revision:

4:3418d67a1969

Parent:

3:0e24c9d4ff2c

Child:

5:a3b5b8fc77e3

--- a/include/Lib17_DIO.h	Mon Apr 11 15:53:36 2011 +0000
+++ b/include/Lib17_DIO.h	Mon Apr 11 15:57:17 2011 +0000
@@ -46,7 +46,6 @@
  * alternate compilers (such as the Code Red GCC C++ compiler for LPCXpresso).
  *
  * @ingroup Lib17_DIO
- * @ingroup API    
  */
 class Lib17_DIO {
 public:
@@ -79,6 +78,7 @@
 public:
 
     /** Constructor
+     * @ingroup Lib17_DIO
      */
     Lib17_DIO(PinName p, Direction d = Out, PinMode m = PullDown) { init(p, d, m); };
 
@@ -88,7 +88,6 @@
      *
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @param i Zero makes the pin 0v, non-zero makes the pin 1.
      */
     void write(int i)     { if (i!=0) { pinUp(); } else { pinDn(); } }
@@ -99,7 +98,6 @@
      *
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @return int 0v returns zero, otherwise returns 1.
      */
     int  read(void)       { return pinIs() ? 1 : 0; };
@@ -121,7 +119,6 @@
      *
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @return int 0v returns zero, otherwise returns 1.
      */
     void input(void)    { *((volatile uint32_t *)fiodir) &= ~mask; }
@@ -132,7 +129,6 @@
      *
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @return int 0v returns zero, otherwise returns 1.
      */
     PinName getPin(void) { return pin; }
@@ -143,7 +139,6 @@
      *
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @return int 0v returns zero, otherwise returns 1.
      */
     int getDirection(void) { return *((volatile uint32_t *)fiomask) & mask ? 1 : 0; }
@@ -155,7 +150,6 @@
      * @see read
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @return int 0v returns zero, otherwise returns 1.
      */
     operator int() { return read(); }
@@ -167,7 +161,6 @@
      * @see write
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      */
     Lib17_DIO& operator= (int value)  { write(value); return *this; }
     
@@ -178,7 +171,6 @@
      * @see write
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      */
     Lib17_DIO& operator= (Lib17_DIO& rhs) { write(rhs.read()); return *this; }
 
@@ -188,7 +180,6 @@
      *
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @return uint32_t The mask value used by this pin.
      */ 
     uint32_t getMask(void)    { return mask;    }
@@ -199,7 +190,6 @@
      *
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @return uint32_t The register value.
      */ 
     uint32_t getFiodir(void)  { return fiodir;  }
@@ -210,7 +200,6 @@
      *
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @return uint32_t The register value.
      */ 
     uint32_t getFiomask(void) { return fiomask; }
@@ -221,7 +210,6 @@
      *
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @return uint32_t The register value.
      */ 
     uint32_t getFiopin(void)  { return fiopin;  }
@@ -232,7 +220,6 @@
      *
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @return uint32_t The register value.
      */ 
     uint32_t getFioset(void)  { return fioset;  }
@@ -243,7 +230,6 @@
      *
      * @see http://cornflakes.wikidot.com/lib17:core:lib17-dio
      * @ingroup Lib17_DIO
-     * @ingroup API 
      * @return uint32_t The register value.
      */ 
     uint32_t getFioclr(void)  { return fioclr;  }