Enabled operator API documentation in drivers

drivers/AnalogOut.h

@@ -103,6 +103,7 @@ public:
     }
 
     /** An operator shorthand for write()
+     * \sa AnalogOut::write()
      */
     AnalogOut& operator= (float percent) {
         // Underlying write call is thread safe
@@ -110,6 +111,9 @@ public:
         return *this;
     }
 
+    /** An operator shorthand for write()
+     * \sa AnalogOut::write()
+     */
     AnalogOut& operator= (AnalogOut& rhs) {
         // Underlying write call is thread safe
         write(rhs.read());
@@ -117,6 +121,7 @@ public:
     }
 
     /** An operator shorthand for read()
+     * \sa AnalogOut::read()
      */
     operator float() {
         // Underlying read call is thread safe

drivers/BusIn.h

@@ -95,10 +95,12 @@ public:
     }
 
     /** A shorthand for read()
+     *  \sa DigitalIn::read()
      */
     operator int();
 
     /** Access to particular bit in random-iterator fashion
+     * @param index  Position of bit
      */
     DigitalIn & operator[] (int index);
 

drivers/BusInOut.h

@@ -108,15 +108,18 @@ public:
     }
 
      /** A shorthand for write()
-     */
+    * \sa BusInOut::write()
+      */
     BusInOut& operator= (int v);
     BusInOut& operator= (BusInOut& rhs);
 
     /** Access to particular bit in random-iterator fashion
-    */
+     * @param index  Bit Position
+     */
     DigitalInOut& operator[] (int index);
 
     /** A shorthand for read()
+     * \sa BusInOut::read()
      */
     operator int();
 

drivers/BusOut.h

@@ -92,15 +92,18 @@ public:
     }
 
     /** A shorthand for write()
+     * \sa BusOut::write()
      */
     BusOut& operator= (int v);
     BusOut& operator= (BusOut& rhs);
 
     /** Access to particular bit in random-iterator fashion
+     * @param index  Bit Position
      */
     DigitalOut& operator[] (int index);
 
     /** A shorthand for read()
+     * \sa BusOut::read()
      */
     operator int();
 

drivers/DigitalIn.h

@@ -102,6 +102,7 @@ public:
     }
 
     /** An operator shorthand for read()
+     * \sa DigitalIn::read()
      */
     operator int() {
         // Underlying read is thread safe

drivers/DigitalInOut.h

@@ -112,6 +112,7 @@ public:
     }
 
     /** A shorthand for write()
+     * \sa DigitalInOut::write()
      */
     DigitalInOut& operator= (int value) {
         // Underlying write is thread safe
@@ -119,6 +120,9 @@ public:
         return *this;
     }
 
+    /** A shorthand for write()
+     * \sa DigitalInOut::write()
+     */
     DigitalInOut& operator= (DigitalInOut& rhs) {
         core_util_critical_section_enter();
         write(rhs.read());
@@ -127,6 +131,7 @@ public:
     }
 
     /** A shorthand for read()
+     * \sa DigitalInOut::read()
      */
     operator int() {
         // Underlying call is thread safe

drivers/DigitalOut.h

@@ -98,6 +98,7 @@ public:
     }
 
     /** A shorthand for write()
+     * \sa DigitalOut::write()
      */
     DigitalOut& operator= (int value) {
         // Underlying write is thread safe
@@ -105,6 +106,9 @@ public:
         return *this;
     }
 
+    /** A shorthand for write()
+     * \sa DigitalOut::write()
+     */
     DigitalOut& operator= (DigitalOut& rhs) {
         core_util_critical_section_enter();
         write(rhs.read());
@@ -113,6 +117,7 @@ public:
     }
 
     /** A shorthand for read()
+     * \sa DigitalOut::read()
      */
     operator int() {
         // Underlying call is thread safe

drivers/PortInOut.h

@@ -89,18 +89,23 @@ public:
     }
 
     /** A shorthand for write()
+     * \sa PortInOut::write()
      */
     PortInOut& operator= (int value) {
         write(value);
         return *this;
     }
 
+    /** A shorthand for write()
+     * \sa PortInOut::write()
+     */
     PortInOut& operator= (PortInOut& rhs) {
         write(rhs.read());
         return *this;
     }
 
     /** A shorthand for read()
+     * \sa PortInOut::read()
      */
     operator int() {
         return read();

drivers/PortOut.h

@@ -83,18 +83,23 @@ public:
     }
 
     /** A shorthand for write()
+     * \sa PortOut::write()
      */
     PortOut& operator= (int value) {
         write(value);
         return *this;
     }
 
+    /** A shorthand for read()
+     * \sa PortOut::read()
+     */
     PortOut& operator= (PortOut& rhs) {
         write(rhs.read());
         return *this;
     }
 
     /** A shorthand for read()
+     * \sa PortOut::read()
      */
     operator int() {
         return read();

drivers/PwmOut.h

@@ -151,6 +151,7 @@ public:
     }
 
     /** A operator shorthand for write()
+     *  \sa PwmOut::write()
      */
     PwmOut& operator= (float value) {
         // Underlying call is thread safe
@@ -159,6 +160,7 @@ public:
     }
 
     /** A operator shorthand for write()
+     * \sa PwmOut::write()
      */    
     PwmOut& operator= (PwmOut& rhs) {
         // Underlying call is thread safe
@@ -167,6 +169,7 @@ public:
     }
 
     /** An operator shorthand for read()
+     * \sa PwmOut::read()
      */
     operator float() {
         // Underlying call is thread safe