Merge branch 'main' into develop

To include hot fix v1.1.1.

CHANGELOG.md

@@ -2,11 +2,25 @@
 History of the project development
 
 ## [Unreleased] yyyy-mm-zz
+Hotfix release. 
+
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+### Known Issue
+
+## [v1.1.1] 2024-10-22
+Hotfix release. 
+
 ### Added
 ### Changed
 ### Deprecated
 ### Removed
 ### Fixed
+- [Issue #24](https://github.com/suikan4github/rpp_driver/issues/24) Doxygen cannot generate document. 
 ### Security
 ### Known Issue
 
@@ -22,7 +36,7 @@ Update to the v1.0.0. The major change is the SdkWrapper class. This class is no
 - [Issue #10](https://github.com/suikan4github/rpp_driver/issues/10) Cover APIs of the Raspberry Pi Pico SDK.
 - [Issue #15](https://github.com/suikan4github/rpp_driver/issues/15) Remove the redundant parameter check code from ConfigureSRC() 
 - [Issue #16](https://github.com/suikan4github/rpp_driver/issues/16) Change the member function name from ConfigureSRC() to ConfigureSrc().
-- [Issue #21](https://github.com/suikan4github/rpp_driver/issues/21) Add usege of the mock for each class description.
+- [Issue #21](https://github.com/suikan4github/rpp_driver/issues/21) Add usage of the mock for each class description.
 - [Issue #22](https://github.com/suikan4github/rpp_driver/issues/22) Refactor the test_i2cmaster.cpp to use the fixture.
 ### Deprecated
 - [Issue #12](https://github.com/suikan4github/rpp_driver/issues/12)  Is I2cMasterInterface needed?  
@@ -65,6 +79,8 @@ First official release of the rpp_driver ( Raspberry Pi Pico Driver) class libra
 ## [v0.9.0] 2024-09-28
 Pre-release version. 
 
-[Unreleased]: https://github.com/suikan4github/rpp_driver/compare/v1.0.0...develop
+[Unreleased]: https://github.com/suikan4github/rpp_driver/compare/v1.1.1...develop
+[v1.1.1]: https://github.com/suikan4github/rpp_driver/compare/v1.1.0...v1.1.1
+[v1.1.0]: https://github.com/suikan4github/rpp_driver/compare/v1.0.0...v1.1.0
 [v1.0.0]: https://github.com/suikan4github/rpp_driver/compare/v0.9.0...v1.0.0
 [v0.9.0]: https://github.com/suikan4github/rpp_driver/compare/v0.0.0...v0.9.0

Doxyfile

@@ -2423,7 +2423,7 @@ 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             =
+PREDEFINED             = DOXYGEN_COMPILE 
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

src/codec/adau1361.hpp

@@ -9,7 +9,7 @@
 
 #ifndef PICO_DRIVER_SRC_CODEC_ADAU1361_HPP_
 #define PICO_DRIVER_SRC_CODEC_ADAU1361_HPP_
-#if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>)
+#if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>) || DOXYGEN_COMPILE
 
 #include <i2c/i2cmaster.hpp>
 
@@ -199,8 +199,11 @@ class Adau1361 {
   bool hp_output_mute_;  // headphone
 };
 
-#if __has_include(<gmock/gmock.h>)
+#if __has_include(<gmock/gmock.h>) || DOXYGEN_COMPILE
 // GCOVR_EXCL_START
+/**
+ * @brief Mock class for test.
+ */
 class MockAdau1361 : public Adau1361 {
  public:
   MockAdau1361(Adau1361Lower& adau1361_lower)

src/codec/adau1361lower.hpp

@@ -9,7 +9,7 @@
 
 #ifndef PICO_DRIVER_SRC_CODEC_ADAU1361LOWER_HPP_
 #define PICO_DRIVER_SRC_CODEC_ADAU1361LOWER_HPP_
-#if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>)
+#if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>) || DOXYGEN_COMPILE
 
 #include "i2c/i2cmaster.hpp"
 
@@ -231,8 +231,11 @@ class Adau1361Lower {
 };
 
 // #ifdef MOCK_METHOD0
-#if __has_include(<gmock/gmock.h>)
+#if __has_include(<gmock/gmock.h>) || DOXYGEN_COMPILE
 // GCOVR_EXCL_START
+/**
+ * @brief Mock class for test.
+ */
 class MockAdau1361Lower : public Adau1361Lower {
  public:
   explicit MockAdau1361Lower(::rpp_driver::I2cMaster& controller)

src/codec/umbadau1361lower.hpp

@@ -9,7 +9,7 @@
 
 #ifndef PICO_DRIVER_SRC_CODEC_UMBADAU1361LOWER_HPP_
 #define PICO_DRIVER_SRC_CODEC_UMBADAU1361LOWER_HPP_
-#if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>)
+#if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>) || DOXYGEN_COMPILE
 
 #include "codec/adau1361lower.hpp"
 #include "i2c/i2cmaster.hpp"

src/i2c/i2cmaster.hpp

@@ -10,7 +10,7 @@
 
 #ifndef PICO_DRIVER_SRC_I2C_I2CMASATER_HPP_
 #define PICO_DRIVER_SRC_I2C_I2CMASATER_HPP_
-#if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>)
+#if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>) || DOXYGEN_COMPILE
 
 #include <stdint.h>
 
@@ -142,8 +142,11 @@ class I2cMaster {
   SdkWrapper &sdk_;
 };  // I2cMaster
 
-#if __has_include(<gmock/gmock.h>)
+#if __has_include(<gmock/gmock.h>)|| DOXYGEN_COMPILE
 // GCOVR_EXCL_START
+/**
+ * @brief Mock class for test.
+ */
 class MockI2cMaster : public I2cMaster {
  private:
   i2c_inst_t dummy_i2c = 3;

src/i2s/i2sslaveduplex.hpp

@@ -5,7 +5,7 @@
  */
 #ifndef PICO_DRIVER_SRC_I2S_DUPLEXSLAVEI2S_HPP_
 #define PICO_DRIVER_SRC_I2S_DUPLEXSLAVEI2S_HPP_
-#if __has_include(<hardware/pio.h>) || __has_include(<gmock/gmock.h>)
+#if __has_include(<hardware/pio.h>) || __has_include(<gmock/gmock.h>) || DOXYGEN_COMPILE
 
 #if __has_include(<hardware/pio.h>)
 #include "hardware/pio.h"
@@ -179,8 +179,11 @@ class I2sSlaveDuplex {
   virtual void PutFifoBlocking(int32_t value);
 };
 
-#if __has_include(<gmock/gmock.h>)
+#if __has_include(<gmock/gmock.h>) || DOXYGEN_COMPILE
 // GCOVR_EXCL_START
+/**
+ * @brief Mock class for test.
+ */
 class MockI2sSlaveDuplex : public I2sSlaveDuplex {
  public:
   MockI2sSlaveDuplex(SdkWrapper &sdk)
@@ -195,6 +198,6 @@ class MockI2sSlaveDuplex : public I2sSlaveDuplex {
 #endif  // __has_include(<gmock/gmock.h>)
 }  // namespace rpp_driver
 
-#endif // __has_include(<hardware/pio.h>) || __has_include(<gmock/gmock.h>)
+#endif  // __has_include(<hardware/pio.h>) || __has_include(<gmock/gmock.h>)
 
 #endif  // PICO_DRIVER_SRC_I2S_DUPLEXSLAVEI2S_HPP_