Issue #3 "Doxygen warning message"

Fix all warning.

Doxyfile has changed to ignore the cpp files. by modifying
FILE_PATTERNS configuration.

Author: suikan4github

Doxyfile

@@ -983,12 +983,7 @@ INPUT_FILE_ENCODING    =
 # provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
 # *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
 
-FILE_PATTERNS          = *.c \
-                         *.cc \
-                         *.cxx \
-                         *.cpp \
-                         *.c++ \
-                         *.java \
+FILE_PATTERNS          = *.java \
                          *.ii \
                          *.ixx \
                          *.ipp \

src/codec/adau1361lower.hpp

@@ -223,7 +223,9 @@ class Adau1361Lower {
   virtual void SetHpOutputGain(float left_gain, float right_gain, bool mute);
 
  protected:
+  /// @brief Internal variable to hold the I2C controller variable.
   ::rpp_driver::I2cMasterInterface& i2c_;
+  /// @brief Internal variable to hold the I2C device address.
   const unsigned int device_addr_;
 };
 

src/gpio/gpiobasic.hpp

@@ -34,15 +34,16 @@ class GpioBasic {
  public:
   /**
    * @brief Initialize the given GPIO pin and setup the pins.
+   * @param sdk Sdk wrapper to inject the dependency.
    * @param pin GPIO pin number.
    * @details
    * Receive the GPIO pin.
-   * And then, init it by ::rpp_driver::gpio_init().
+   * And then, init it by SdkWrapper::gpio_init().
    */
   GpioBasic(SdkWrapper &sdk, uint pin);
   GpioBasic() = delete;
   /**
-   * @brief deinit the GPIO by ::rpp_driver::gpio_deinit();
+   * @brief deinit the GPIO by SdkWrapper::gpio_deinit();
    */
   virtual ~GpioBasic();
   /**

src/i2c/i2cmaster.hpp

@@ -16,9 +16,12 @@
 #if __has_include(<hardware/i2c.h>)
 #include "hardware/i2c.h"
 #else
-// Alternate definition for unit test.
+/// Alternate definition for unit test.
 typedef int i2c_inst_t;
+/// Alternate definition of the return value on error for Google Test build.
 #define PICO_ERROR_GENERIC -1
+/// Alternate definition of the return value on error for I2C function number
+/// for GPIO.
 #define GPIO_FUNC_I2C 11
 #endif  // __has_include(<hardware/i2c.h>)
 
@@ -51,14 +54,14 @@ class I2cMaster : public I2cMasterInterface {
    * @param sda_pin GPIO pin #
    * @details
    * Receive the uninitialized I2C hardware by parameter i2c, and initialize
-   * it by ::rpp_driver::i2c_init().
+   * it by SdkWrapper::i2c_init().
    * And then, set given pins to I2C function, and pull them up.
    */
   I2cMaster(SdkWrapper &sdk, i2c_inst_t &i2c, uint clock_freq, uint scl_pin,
             uint sda_pin);
   I2cMaster() = delete;
   /**
-   * @brief deinit the I2C by ::rpp_driver::i2c_deinit();
+   * @brief deinit the I2C by SdkWrapper::i2c_deinit();
    */
   virtual ~I2cMaster();
   /**

src/i2c/i2cmasterinterface.hpp

@@ -16,6 +16,7 @@
 #include <stdlib.h>
 
 #if !__has_include(<hardware/i2c.h>)
+/// @brief  Alternate definition of the uint for Google Test build.
 typedef unsigned uint;
 #endif
 

src/sdk/sdkwrapper.hpp

@@ -20,11 +20,17 @@
 // Alternative include and definition for Unix/Win32
 #include <stdint.h>
 #include <stdlib.h>
+/// @brief Alternate definition for Google Test build.
 typedef int i2c_inst_t;
+/// @brief Alternate definition for Google Test build.
 typedef int gpio_function_t;
+/// @brief Alternate definition for Google Test build.
 typedef unsigned int PIO;
+/// @brief Alternate definition for Google Test build.
 typedef unsigned int pio_sm_config;
+/// @brief Alternate definition for Google Test build.
 typedef unsigned int clock_handle_t;
+/// @brief Alternate definition for Google Test build.
 typedef unsigned int pio_program_t;
 #ifdef _MSC_VER
 typedef unsigned int uint;