Merge pull request #8423 from cmonr/rollup2

Rollup PR: Additional doc PRs + lingering need:CI PRs

Author: Cruz Monrreal

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

drivers/I2C.h

@@ -41,16 +41,32 @@ namespace mbed {
  *
  * Example:
  * @code
- * // Read from I2C slave at address 0x62
- *
+ * Read temperature from LM75BD
  * #include "mbed.h"
- *
- * I2C i2c(p28, p27);
+ * I2C i2c(I2C_SDA , I2C_SCL);
+ * const int addr7bit = 0x48;      // 7-bit I2C address
+ * const int addr8bit = 0x48 << 1; // 8-bit I2C address, 0x90
  *
  * int main() {
- *     int address = 0x62;
- *     char data[2];
- *     i2c.read(address, data, 2);
+ *     char cmd[2];
+ *     while (1) {
+ *         cmd[0] = 0x01;
+ *         cmd[1] = 0x00;
+ *
+ *         // read and write takes the 8-bit version of the address.
+ *         // set up configuration register (at 0x01)
+ *         i2c.write(addr8bit, cmd, 2);
+ *
+ *         wait(0.5);
+ *
+ *         // read temperature register
+ *         cmd[0] = 0x00;
+ *         i2c.write(addr8bit, cmd, 1);
+ *         i2c.read( addr8bit, cmd, 2);
+ *
+ *         float tmp = (float((cmd[0]<<8)|cmd[1]) / 256.0);
+ *         printf("Temp = %.2f\n", tmp);
+ *   }
  * }
  * @endcode
  * @ingroup drivers
@@ -92,10 +108,11 @@ class I2C : private NonCopyable<I2C> {
      *  @param data Pointer to the byte-array to read data in to
      *  @param length Number of bytes to read
      *  @param repeated Repeated start, true - don't send stop at end
+	 *         default value is false.
      *
      *  @returns
      *       0 on success (ack),
-     *   non-0 on failure (nack)
+     *       nonzero on failure (nack)
      */
     int read(int address, char *data, int length, bool repeated = false);
 
@@ -117,10 +134,11 @@ class I2C : private NonCopyable<I2C> {
      *  @param data Pointer to the byte-array data to send
      *  @param length Number of bytes to send
      *  @param repeated Repeated start, true - do not send stop at end
+	 *         default value is false.
      *
      *  @returns
      *       0 on success (ack),
-     *   non-0 on failure (nack)
+     *       nonzero on failure (nack)
      */
     int write(int address, const char *data, int length, bool repeated = false);
 
@@ -137,7 +155,6 @@ class I2C : private NonCopyable<I2C> {
 
     /** Creates a start condition on the I2C bus
      */
-
     void start(void);
 
     /** Creates a stop condition on the I2C bus
@@ -159,23 +176,25 @@ class I2C : private NonCopyable<I2C> {
 
 #if DEVICE_I2C_ASYNCH
 
-    /** Start non-blocking I2C transfer.
+    /** Start nonblocking I2C transfer.
      *
      * This function locks the deep sleep until any event has occurred
      *
      * @param address   8/10 bit I2C slave address
      * @param tx_buffer The TX buffer with data to be transfered
      * @param tx_length The length of TX buffer in bytes
-     * @param rx_buffer The RX buffer which is used for received data
+     * @param rx_buffer The RX buffer, which is used for received data
      * @param rx_length The length of RX buffer in bytes
      * @param event     The logical OR of events to modify
      * @param callback  The event callback function
      * @param repeated Repeated start, true - do not send stop at end
-     * @return Zero if the transfer has started, or -1 if I2C peripheral is busy
+	 *        default value is false.
+	 *
+     * @returns Zero if the transfer has started, or -1 if I2C peripheral is busy
      */
     int transfer(int address, const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length, const event_callback_t &callback, int event = I2C_EVENT_TRANSFER_COMPLETE, bool repeated = false);
 
-    /** Abort the on-going I2C transfer
+    /** Abort the ongoing I2C transfer
      */
     void abort_transfer();
 
@@ -193,6 +212,7 @@ class I2C : private NonCopyable<I2C> {
     bool _deep_sleep_locked;
 #endif
 
+#if !defined(DOXYGEN_ONLY)
 protected:
     void aquire();
 
@@ -202,6 +222,7 @@ class I2C : private NonCopyable<I2C> {
     static SingletonPtr<PlatformMutex> _mutex;
     PinName _sda;
     PinName _scl;
+#endif
 
 private:
     /** Recover I2C bus, when stuck with SDA low
@@ -210,7 +231,7 @@ class I2C : private NonCopyable<I2C> {
      *  @param sda I2C data line pin
      *  @param scl I2C clock line pin
      *
-     * @returns:
+     * @returns
      *    '0' - Successfully recovered
      *    'I2C_ERROR_BUS_BUSY' - In case of failure
      *

events/EventQueue.h

@@ -2803,6 +2803,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
     #endif
 
 protected:
+    #if !defined(DOXYGEN_ONLY)
     template <typename F>
     friend class Event;
     struct equeue _equeue;
@@ -3379,6 +3380,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
             f(c0, c1, c2, c3, c4, a0, a1, a2, a3, a4);
         }
     };
+    #endif //!defined(DOXYGEN_ONLY)
 };
 
 }

features/FEATURE_BOOTLOADER/targets/TARGET_STM/TARGET_STM32L4/TARGET_STM32L475xG/TARGET_DISCO_L475VG_IOT01A/LICENSE

@@ -0,0 +1,49 @@
+Permissive Binary License
+
+Version 1.0, September 2015
+
+Redistribution.  Redistribution and use in binary form, without
+modification, are permitted provided that the following conditions are
+met:
+
+1) Redistributions must reproduce the above copyright notice and the
+   following disclaimer in the documentation and/or other materials
+   provided with the distribution.
+
+2) Unless to the extent explicitly permitted by law, no reverse
+   engineering, decompilation, or disassembly of this software is
+   permitted.
+
+3) Redistribution as part of a software development kit must include the
+   accompanying file named "DEPENDENCIES" and any dependencies listed in
+   that file.
+
+4) Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission. 
+
+Limited patent license. The copyright holders (and contributors) grant a
+worldwide, non-exclusive, no-charge, royalty-free patent license to
+make, have made, use, offer to sell, sell, import, and otherwise
+transfer this software, where such license applies only to those patent
+claims licensable by the copyright holders (and contributors) that are
+necessarily infringed by this software. This patent license shall not
+apply to any combinations that include this software.  No hardware is
+licensed hereunder.
+
+If you institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the software
+itself infringes your patent(s), then your rights granted under this
+license shall terminate as of the date such litigation is filed.
+
+DISCLAIMER. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS." ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

features/FEATURE_BOOTLOADER/targets/TARGET_STM/TARGET_STM32L4/TARGET_STM32L475xG/TARGET_DISCO_L475VG_IOT01A/mbed-bootloader-internal_dfb7cc.bin

@@ -0,0 +1,10 @@
+{
+    "name": "bootloader_DISCO_L475VG_IOT01A",
+    "target_overrides": {
+        "*": {
+            "target.app_offset": "0x9800",
+            "target.header_offset": "0x9000",
+            "target.bootloader_img": "mbed-bootloader-internal_dfb7cc.bin"
+        }
+    }
+}