Merge pull request #565 from UncleRus/bugfix/build-docs-ci

chore: add check doxygen warnings to ci
UncleRus · Aug 19, 2023 · b564a34 · b564a34
2 parents f72ffcf + 3fd4d34
commit b564a34
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 47 deletions.
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -89,11 +89,19 @@ jobs:
           sudo apt-get update
           sudo apt-get install python3-sphinx python3-sphinx-rtd-theme python3-breathe doxygen
 
-      # FIXME: extract doxygen and sphinx errors and warnings, not just run make!
+      # FIXME: extract sphinx errors and warnings, not just run make!
       - id: build
         name: Build docs
         run: |
-          make -C docs dirhtml
+          cd docs
+          make dirhtml
+          if [ -s doxygen.log ]; then
+            echo "========================================================="
+            echo "Found errors:"
+            echo "========================================================="
+            cat doxygen.log
+            exit 1
+          fi
 
   build_esp32xx:
     name: Build for ESP32xx

diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
diff --git a/components/ls7366r/ls7366r.h b/components/ls7366r/ls7366r.h
@@ -248,9 +248,11 @@ esp_err_t ls7366r_clear_counter(ls7366r_t *dev);
  * @return `ESP_OK` on success
  */
 esp_err_t ls7366r_counter_enable(ls7366r_t *dev, bool enable);
-	
+
 #ifdef __cplusplus
 }
 #endif
 
+/**@}*/
+
 #endif /* __LS7366R_H__ */
diff --git a/components/mpu6050/mpu6050.h b/components/mpu6050/mpu6050.h
@@ -1746,7 +1746,6 @@ esp_err_t mpu6050_get_motion(mpu6050_dev_t *dev, mpu6050_acceleration_t *data_ac
  * information regarding the characteristics of Slave 4, please refer to
  * Registers 49 to 53.
  *
- * @example
  * Suppose that Slave 0 is enabled with 4 bytes to be read (I2C_SLV0_EN = 1 and
  * I2C_SLV0_LEN = 4) while Slave 1 is enabled with 2 bytes to be read so that
  * I2C_SLV1_EN = 1 and I2C_SLV1_LEN = 2. In such a situation, EXT_SENS_DATA _00

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -2,3 +2,4 @@
 /latex/
 /build/
 /xml/
+doxygen.log
diff --git a/docs/Makefile b/docs/Makefile
@@ -22,7 +22,10 @@ help:
 	@echo "  man        to make manual pages"
 	@echo "  all        to make all of the above"
 
-xml/index.xml:
+$(BUILDDIR):
+	mkdir $(BUILDDIR)
+
+xml/index.xml: $(BUILDDIR)
 	doxygen doxygen.conf
 	sed -i 's/LIB8STATIC_ALWAYS_INLINE/inline static/g' xml/*.xml
 	sed -i 's/LIB8STATIC/inline static/g' xml/*.xml

diff --git a/docs/doxygen.conf b/docs/doxygen.conf
@@ -894,7 +894,7 @@ WARN_LINE_FORMAT       = "at line $line of file $file"
 # specified the warning and error messages are written to standard output
 # (stdout).
 
-WARN_LOGFILE           =
+WARN_LOGFILE           = doxygen.log
 
 #---------------------------------------------------------------------------
 # Configuration options related to the input files