Remove protected members from doxy in Analog/Digital classes

- Add example snippets to Analog/Digital read/write overrides

Author: kegilbert

drivers/AnalogIn.h

@@ -114,7 +114,7 @@ class AnalogIn {
     }
 
 protected:
-
+    #if !defined(DOXYGEN_ONLY)
     virtual void lock()
     {
         _mutex->lock();
@@ -127,6 +127,7 @@ class AnalogIn {
 
     analogin_t _adc;
     static SingletonPtr<PlatformMutex> _mutex;
+    #endif //!defined(DOXYGEN_ONLY)
 };
 
 } // namespace mbed

drivers/AnalogOut.h

@@ -141,7 +141,7 @@ class AnalogOut {
     }
 
 protected:
-
+    #if !defined(DOXYGEN_ONLY)
     virtual void lock()
     {
         _mutex.lock();
@@ -154,6 +154,7 @@ class AnalogOut {
 
     dac_t _dac;
     PlatformMutex _mutex;
+    #endif //!defined(DOXYGEN_ONLY)
 };
 
 } // namespace mbed

drivers/DigitalIn.h

@@ -108,6 +108,11 @@ class DigitalIn {
 
     /** An operator shorthand for read()
      * \sa DigitalIn::read()
+     * @code
+     *      DigitalIn  button(BUTTON1);
+     *      DigitalOut led(LED1);
+     *      led = button;   // Equivalent to led.write(button.read())
+     * @endcode
      */
     operator int()
     {
@@ -116,7 +121,9 @@ class DigitalIn {
     }
 
 protected:
+    #if !defined(DOXYGEN_ONLY)
     gpio_t gpio;
+    #endif //!defined(DOXYGEN_ONLY)
 };
 
 } // namespace mbed

drivers/DigitalInOut.h

@@ -121,6 +121,13 @@ class DigitalInOut {
 
     /** A shorthand for write()
      * \sa DigitalInOut::write()
+     * @code
+     *      DigitalInOut  inout(PIN);
+     *      DigitalIn     button(BUTTON1);
+     *      inout.output();
+     *
+     *      inout = button;     // Equivalent to inout.write(button.read())
+     * @endcode
      */
     DigitalInOut &operator= (int value)
     {
@@ -129,7 +136,8 @@ class DigitalInOut {
         return *this;
     }
 
-    /** A shorthand for write()
+    /**A shorthand for write() using the assignment operator which copies the
+     * state from the DigitalInOut argument.
      * \sa DigitalInOut::write()
      */
     DigitalInOut &operator= (DigitalInOut &rhs)
@@ -142,6 +150,13 @@ class DigitalInOut {
 
     /** A shorthand for read()
      * \sa DigitalInOut::read()
+     * @code
+     *      DigitalInOut inout(PIN);
+     *      DigitalOut led(LED1);
+     *
+     *      inout.input();
+     *      led = inout;   // Equivalent to led.write(inout.read())
+     * @endcode
      */
     operator int()
     {
@@ -150,7 +165,9 @@ class DigitalInOut {
     }
 
 protected:
+    #if !defined(DOXYGEN_ONLY)
     gpio_t gpio;
+    #endif //!defined(DOXYGEN_ONLY)
 };
 
 } // namespace mbed

drivers/DigitalOut.h

@@ -104,6 +104,11 @@ class DigitalOut {
 
     /** A shorthand for write()
      * \sa DigitalOut::write()
+     * @code
+     *      DigitalIn  button(BUTTON1);
+     *      DigitalOut led(LED1);
+     *      led = button;   // Equivalent to led.write(button.read())
+     * @endcode
      */
     DigitalOut &operator= (int value)
     {
@@ -112,7 +117,8 @@ class DigitalOut {
         return *this;
     }
 
-    /** A shorthand for write()
+    /** A shorthand for write() using the assignment operator which copies the
+     * state from the DigitalOut argument.
      * \sa DigitalOut::write()
      */
     DigitalOut &operator= (DigitalOut &rhs)
@@ -125,6 +131,11 @@ class DigitalOut {
 
     /** A shorthand for read()
      * \sa DigitalOut::read()
+     * @code
+     *      DigitalIn  button(BUTTON1);
+     *      DigitalOut led(LED1);
+     *      led = button;   // Equivalent to led.write(button.read())
+     * @endcode
      */
     operator int()
     {
@@ -133,7 +144,9 @@ class DigitalOut {
     }
 
 protected:
+    #if !defined(DOXYGEN_ONLY)
     gpio_t gpio;
+    #endif //!defined(DOXYGEN_ONLY)
 };
 
 } // namespace mbed