Merge pull request #4895 from c1728p9/device_has_doxygen

Turn on doxygen for DEVICE_* features

Author: theotherjimmy

doxyfile_options

@@ -2056,7 +2056,32 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = DOXYGEN_ONLY \
+PREDEFINED             = DOXYGEN_ONLY            \
+                         DEVICE_ANALOGIN         \
+                         DEVICE_ANALOGOUT        \
+                         DEVICE_CAN              \
+                         DEVICE_ETHERNET         \
+                         DEVICE_EMAC             \
+                         DEVICE_FLASH            \
+                         DEVICE_I2C              \
+                         DEVICE_I2CSLAVE         \
+                         DEVICE_I2C_ASYNCH       \
+                         DEVICE_INTERRUPTIN      \
+                         DEVICE_LOWPOWERTIMER    \
+                         DEVICE_PORTIN           \
+                         DEVICE_PORTINOUT        \
+                         DEVICE_PORTOUT          \
+                         DEVICE_PWMOUT           \
+                         DEVICE_RTC              \
+                         DEVICE_TRNG             \
+                         DEVICE_SERIAL           \
+                         DEVICE_SERIAL_ASYNCH    \
+                         DEVICE_SERIAL_FC        \
+                         DEVICE_SLEEP            \
+                         DEVICE_SPI              \
+                         DEVICE_SPI_ASYNCH       \
+                         DEVICE_SPISLAVE         \
+                         DEVICE_STORAGE          \
                          "MBED_DEPRECATED_SINCE(d, m)=" \
                          "MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)="
 

doxygen_options.json

@@ -5,7 +5,7 @@
     "SEARCH_INCLUDES": "YES",
     "INCLUDE_PATH": "", 
     "INCLUDE_FILE_PATTERNS": "", 
-    "PREDEFINED": "DOXYGEN_ONLY \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\"",
+    "PREDEFINED": "DOXYGEN_ONLY DEVICE_ANALOGIN DEVICE_ANALOGOUT DEVICE_CAN DEVICE_ETHERNET DEVICE_EMAC DEVICE_FLASH  DEVICE_I2C DEVICE_I2CSLAVE DEVICE_I2C_ASYNCH DEVICE_INTERRUPTIN DEVICE_LOWPOWERTIMER DEVICE_PORTIN DEVICE_PORTINOUT DEVICE_PORTOUT DEVICE_PWMOUT DEVICE_RTC DEVICE_TRNG DEVICE_SERIAL DEVICE_SERIAL_ASYNCH DEVICE_SERIAL_FC DEVICE_SLEEP DEVICE_SPI DEVICE_SPI_ASYNCH DEVICE_SPISLAVE DEVICE_STORAGE \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\"",
     "EXPAND_AS_DEFINED": "", 
     "SKIP_FUNCTION_MACROS": "NO",
     "EXCLUDE_PATTERNS": "*/tools/* */TESTS/* */targets/* */FEATURE_*/* */features/mbedtls/* */features/storage/* */features/unsupported/* */features/filesystem/* */BUILD/* */rtos/rtx*/* */cmsis/* */features/FEATURES_*"

features/netsocket/emac_stack_mem.h

@@ -89,7 +89,7 @@ void emac_stack_mem_set_len(emac_stack_t* stack, emac_stack_mem_t *mem, uint32_t
  * Returns first memory structure from the list and move the head to point to the next node
  *
  * @param  stack Emac stack context
- * @param  list Pointer to the list
+ * @param  chain Pointer to the list
  * @return      First memory structure from the list
  */
 emac_stack_mem_t *emac_stack_mem_chain_dequeue(emac_stack_t* stack, emac_stack_mem_chain_t **chain);

hal/flash_api.h

@@ -98,7 +98,6 @@ uint32_t flash_get_sector_size(const flash_t *obj, uint32_t address);
 /** Get page size
  *
  * @param obj The flash object
- * @param address The page starting address
  * @return The size of a page
  */
 uint32_t flash_get_page_size(const flash_t *obj);

hal/i2c_api.h

@@ -156,6 +156,7 @@ int i2c_byte_write(i2c_t *obj, int data);
 
 /** Configure I2C as slave or master.
  *  @param obj The I2C object
+ *  @param enable_slave Enable i2c hardware so you can receive events with ::i2c_slave_receive
  *  @return non-zero if a value is available
  */
 void i2c_slave_mode(i2c_t *obj, int enable_slave);
@@ -169,12 +170,16 @@ int  i2c_slave_receive(i2c_t *obj);
 
 /** Configure I2C as slave or master.
  *  @param obj The I2C object
+ *  @param data    The buffer for receiving
+ *  @param length  Number of bytes to read
  *  @return non-zero if a value is available
  */
 int  i2c_slave_read(i2c_t *obj, char *data, int length);
 
 /** Configure I2C as slave or master.
  *  @param obj The I2C object
+ *  @param data    The buffer for sending
+ *  @param length  Number of bytes to write
  *  @return non-zero if a value is available
  */
 int  i2c_slave_write(i2c_t *obj, const char *data, int length);
@@ -208,6 +213,7 @@ void i2c_slave_address(i2c_t *obj, int idx, uint32_t address, uint32_t mask);
  *  @param address   The address to be set - 7bit or 9bit
  *  @param stop      If true, stop will be generated after the transfer is done
  *  @param handler   The I2C IRQ handler to be set
+ *  @param event     Event mask for the transfer. See \ref hal_I2CEvents
  *  @param hint      DMA hint usage
  */
 void i2c_transfer_asynch(i2c_t *obj, const void *tx, size_t tx_length, void *rx, size_t rx_length, uint32_t address, uint32_t stop, uint32_t handler, uint32_t event, DMAUsage hint);