Output all bus-type API variants in Doxygen and complete native comments

Author: GOB52

src/M5UnitComponent.hpp

@@ -28,7 +28,7 @@
 #include <type_traits>
 #include <memory>
 
-#if defined(ARDUINO)
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
 class TwoWire;
 class HardwareSerial;
 class SPIClass;
@@ -298,19 +298,30 @@ class Component {
 
     ///@name Assign(I2C)
     ///@{
-#if defined(ARDUINO)
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
     /*!
       @brief Assign TwoWire as the communication bus
       @param wire TwoWire to be used
       @return True if successful
     */
     virtual bool assign(TwoWire& wire);
 #endif
-#if defined(ESP_PLATFORM) && __has_include(<driver/i2c_master.h>)
-    /*! @brief Assign I2C master bus (ESP-IDF native driver) */
+#if defined(DOXYGEN_PROCESS) || (defined(ESP_PLATFORM) && __has_include(<driver/i2c_master.h>))
+    /*!
+      @brief Assign I2C master bus (ESP-IDF native driver)
+      @param bus ESP-IDF I2C master bus handle
+      @return True if successful
+     */
     virtual bool assign(i2c_master_bus_handle_t bus);
-#elif defined(ESP_PLATFORM)
-    /*! @brief Assign I2C (ESP-IDF legacy driver, pre-installed port) */
+#endif
+#if defined(DOXYGEN_PROCESS) || (defined(ESP_PLATFORM) && !__has_include(<driver/i2c_master.h>))
+    /*!
+      @brief Assign I2C (ESP-IDF legacy driver, pre-installed port)
+      @param port I2C port (the driver must be installed beforehand via i2c_param_config / i2c_driver_install)
+      @param sda SDA GPIO
+      @param scl SCL GPIO
+      @return True if successful
+     */
     virtual bool assign(const i2c_port_t port, const gpio_num_t sda, const gpio_num_t scl);
 #endif
     /*!
@@ -334,32 +345,44 @@ class Component {
 
     ///@name Assign(UART)
     ///@{
-#if defined(ARDUINO)
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
     /*!
       @brief Assign HardwareSerial as the communication bus
       @param serial HardwareSerial to be used
       @return True if successful
     */
     virtual bool assign(HardwareSerial& serial);
 #endif
-#if defined(ESP_PLATFORM)
-    /*! @brief Assign UART (ESP-IDF native driver, pre-installed port) */
+#if defined(ESP_PLATFORM) || defined(DOXYGEN_PROCESS)
+    /*!
+      @brief Assign UART (ESP-IDF native driver, pre-installed port)
+      @param uart_num UART port number (the driver must be installed beforehand via
+                      uart_driver_install / uart_param_config / uart_set_pin)
+      @return True if successful
+     */
     virtual bool assign(const uart_port_t uart_num);
-    //! @brief Assign SPI device handle (ESP-IDF native, borrowed; cs controlled manually)
-    virtual bool assign(spi_device_handle_t handle, const gpio_num_t cs);
 #endif
     ///@}
 
     ///@name Assign(SPI)
     ///@{
-#if defined(ARDUINO)
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
     /*!
       @brief Assign SPIClass as the communication bus
       @param spi SPIClass to be used
       @param settings SPI settings to be applied
       @return True if successful
     */
     virtual bool assign(SPIClass& spi, const SPISettings& settings);
+#endif
+#if defined(ESP_PLATFORM) || defined(DOXYGEN_PROCESS)
+    /*!
+      @brief Assign SPI device handle (ESP-IDF native driver, borrowed)
+      @param handle ESP-IDF SPI device handle (create with spics_io_num = -1; init bus with SPI_DMA_DISABLED)
+      @param cs CS GPIO controlled manually by this library
+      @return True if successful
+     */
+    virtual bool assign(spi_device_handle_t handle, const gpio_num_t cs);
 #endif
     ///@}
 

src/M5UnitUnified.hpp

@@ -25,7 +25,7 @@
 #include <vector>
 #include <string>
 
-#if defined(ARDUINO)
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
 class TwoWire;
 class HardwareSerial;
 class SPIClass;
@@ -71,7 +71,7 @@ class UnitUnified {
 
     ///@name Add unit(I2C)
     ///@{
-#if defined(ARDUINO)
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
     /*!
       @brief Add unit to be managed (I2C via TwoWire)
       @param u Unit Component
@@ -80,15 +80,16 @@ class UnitUnified {
     */
     bool add(Component& u, TwoWire& wire);
 #endif
-#if defined(ESP_PLATFORM) && __has_include(<driver/i2c_master.h>)
+#if defined(DOXYGEN_PROCESS) || (defined(ESP_PLATFORM) && __has_include(<driver/i2c_master.h>))
     /*!
       @brief Adding unit to be managed (I2C, ESP-IDF native driver)
       @param u Unit Component
       @param bus ESP-IDF I2C master bus handle
       @return True if successful
      */
     bool add(Component& u, i2c_master_bus_handle_t bus);
-#elif defined(ESP_PLATFORM)
+#endif
+#if defined(DOXYGEN_PROCESS) || (defined(ESP_PLATFORM) && !__has_include(<driver/i2c_master.h>))
     /*!
       @brief Adding unit to be managed (I2C, ESP-IDF legacy driver)
       @param u Unit Component
@@ -122,7 +123,7 @@ class UnitUnified {
 
     ///@name Add unit(UART)
     ///@{
-#if defined(ARDUINO)
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
     /*!
       @brief Add unit to be managed (UART)
       @param u Unit Component
@@ -131,7 +132,7 @@ class UnitUnified {
     */
     bool add(Component& u, HardwareSerial& serial);
 #endif
-#if defined(ESP_PLATFORM)
+#if defined(ESP_PLATFORM) || defined(DOXYGEN_PROCESS)
     /*!
       @brief Adding unit to be managed (UART, ESP-IDF native driver)
       @param u Unit Component
@@ -145,7 +146,7 @@ class UnitUnified {
 
     ///@name Add unit(SPI)
     ///@{
-#if defined(ARDUINO)
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
     /*!
       @brief Add unit to be managed (SPI)
       @param u Unit Component
@@ -155,7 +156,7 @@ class UnitUnified {
     */
     bool add(Component& u, SPIClass& spi, const SPISettings& settings);
 #endif
-#if defined(ESP_PLATFORM)
+#if defined(ESP_PLATFORM) || defined(DOXYGEN_PROCESS)
     /*!
       @brief Adding unit to be managed (SPI, ESP-IDF native driver)
       @param u Unit Component