[SKIP CI] .github: doxygen: upgrade to Ubuntu 22.04

.github/workflows/pull-request.yml

@@ -37,20 +37,30 @@ on:
 jobs:
 
   doxygen:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
       - uses: actions/checkout@v2
 
       - name: apt get doxygen graphviz
         run: sudo apt-get -y install ninja-build doxygen graphviz
 
-      - name: list all warnings, warnings are not failures
+      - name: Show warnings but fail only on errors
         run: cmake -GNinja -S doc -B docbuild && ninja -C docbuild -v doc
 
-      # Build again (it's very quick) so warnings don't go unnoticed
-      - name: fail and stop on first warning
-        run: printf 'WARN_AS_ERROR = YES\n' >> doc/sof.doxygen.in &&
+      # Build again (it's very quick) so warnings don't go unnoticed.
+      # For older doxygen versions that don't have FAIL_ON_WARNINGS, use
+      # WARN_AS_ERROR = YES instead. 'YES' is inferior because it stops
+      # on the first error.
+      #
+      # Note some doxygen bug(s) can cause some specific error types to
+      # escape WARN_AS_ERROR, example:
+      # https://github.com/doxygen/doxygen/issues/7970 and
+      # https://github.com/thesofproject/sof/pull/5978
+
+      - name: Fail on warnings
+        run: printf
+          'WARN_AS_ERROR = FAIL_ON_WARNINGS\n' >> doc/sof.doxygen.in &&
           ninja -C docbuild -v doc
 
 

src/include/sof/audio/coefficients/src/src_ipc4_int32_10_21_2500_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -454,3 +455,4 @@ const int32_t src_int32_10_21_2500_5000_fir[440] = {
 struct src_stage src_int32_10_21_2500_5000 = {
 	2, 1, 10, 44, 440, 21, 10, 0, 1,
 	src_int32_10_21_2500_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_10_21_3455_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -614,3 +615,4 @@ const int32_t src_int32_10_21_3455_5000_fir[600] = {
 struct src_stage src_int32_10_21_3455_5000 = {
 	2, 1, 10, 60, 600, 21, 10, 0, 1,
 	src_int32_10_21_3455_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_10_21_4535_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -1974,3 +1975,4 @@ const int32_t src_int32_10_21_4535_5000_fir[1960] = {
 struct src_stage src_int32_10_21_4535_5000 = {
 	2, 1, 10, 196, 1960, 21, 10, 0, 1,
 	src_int32_10_21_4535_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_10_9_4535_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -974,3 +975,4 @@ const int32_t src_int32_10_9_4535_5000_fir[960] = {
 struct src_stage src_int32_10_9_4535_5000 = {
 	8, 9, 10, 96, 960, 9, 10, 0, 0,
 	src_int32_10_9_4535_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_16_21_4319_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -1358,3 +1359,4 @@ const int32_t src_int32_16_21_4319_5000_fir[1344] = {
 struct src_stage src_int32_16_21_4319_5000 = {
 	17, 13, 16, 84, 1344, 21, 16, 0, 0,
 	src_int32_16_21_4319_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_16_21_4535_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -1998,3 +1999,4 @@ const int32_t src_int32_16_21_4535_5000_fir[1984] = {
 struct src_stage src_int32_16_21_4535_5000 = {
 	17, 13, 16, 124, 1984, 21, 16, 0, 0,
 	src_int32_16_21_4535_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_16_7_4082_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -782,3 +783,4 @@ const int32_t src_int32_16_7_4082_5000_fir[768] = {
 struct src_stage src_int32_16_7_4082_5000 = {
 	3, 7, 16, 48, 768, 7, 16, 0, 0,
 	src_int32_16_7_4082_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_2_2268_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -54,3 +55,4 @@ const int32_t src_int32_1_2_2268_5000_fir[40] = {
 struct src_stage src_int32_1_2_2268_5000 = {
 	1, 0, 1, 40, 40, 2, 1, 0, 1,
 	src_int32_1_2_2268_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_2_2500_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -58,3 +59,4 @@ const int32_t src_int32_1_2_2500_5000_fir[44] = {
 struct src_stage src_int32_1_2_2500_5000 = {
 	1, 0, 1, 44, 44, 2, 1, 0, 1,
 	src_int32_1_2_2500_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_2_2721_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -58,3 +59,4 @@ const int32_t src_int32_1_2_2721_5000_fir[44] = {
 struct src_stage src_int32_1_2_2721_5000 = {
 	1, 0, 1, 44, 44, 2, 1, 0, 1,
 	src_int32_1_2_2721_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_2_3401_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -78,3 +79,4 @@ const int32_t src_int32_1_2_3401_5000_fir[64] = {
 struct src_stage src_int32_1_2_3401_5000 = {
 	1, 0, 1, 64, 64, 2, 1, 0, 1,
 	src_int32_1_2_3401_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_2_3887_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -106,3 +107,4 @@ const int32_t src_int32_1_2_3887_5000_fir[92] = {
 struct src_stage src_int32_1_2_3887_5000 = {
 	1, 0, 1, 92, 92, 2, 1, 0, 1,
 	src_int32_1_2_3887_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_2_4535_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -226,3 +227,4 @@ const int32_t src_int32_1_2_4535_5000_fir[212] = {
 struct src_stage src_int32_1_2_4535_5000 = {
 	1, 0, 1, 212, 212, 2, 1, 0, 1,
 	src_int32_1_2_4535_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_3_2268_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -70,3 +71,4 @@ const int32_t src_int32_1_3_2268_5000_fir[56] = {
 struct src_stage src_int32_1_3_2268_5000 = {
 	1, 0, 1, 56, 56, 3, 1, 0, 2,
 	src_int32_1_3_2268_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_3_4535_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -306,3 +307,4 @@ const int32_t src_int32_1_3_4535_5000_fir[292] = {
 struct src_stage src_int32_1_3_4535_5000 = {
 	1, 0, 1, 292, 292, 3, 1, 0, 1,
 	src_int32_1_3_4535_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_4_1512_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -74,3 +75,4 @@ const int32_t src_int32_1_4_1512_5000_fir[60] = {
 struct src_stage src_int32_1_4_1512_5000 = {
 	1, 0, 1, 60, 60, 4, 1, 0, 2,
 	src_int32_1_4_1512_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_4_2268_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -86,3 +87,4 @@ const int32_t src_int32_1_4_2268_5000_fir[72] = {
 struct src_stage src_int32_1_4_2268_5000 = {
 	1, 0, 1, 72, 72, 4, 1, 0, 2,
 	src_int32_1_4_2268_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_4_4535_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -390,3 +391,4 @@ const int32_t src_int32_1_4_4535_5000_fir[376] = {
 struct src_stage src_int32_1_4_4535_5000 = {
 	1, 0, 1, 376, 376, 4, 1, 0, 2,
 	src_int32_1_4_4535_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_1_6_1134_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -94,3 +95,4 @@ const int32_t src_int32_1_6_1134_5000_fir[80] = {
 struct src_stage src_int32_1_6_1134_5000 = {
 	1, 0, 1, 80, 80, 6, 1, 0, 3,
 	src_int32_1_6_1134_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_20_21_1250_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -334,3 +335,4 @@ const int32_t src_int32_20_21_1250_5000_fir[320] = {
 struct src_stage src_int32_20_21_1250_5000 = {
 	1, 1, 20, 16, 320, 21, 20, 0, 0,
 	src_int32_20_21_1250_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_20_21_2500_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -494,3 +495,4 @@ const int32_t src_int32_20_21_2500_5000_fir[480] = {
 struct src_stage src_int32_20_21_2500_5000 = {
 	1, 1, 20, 24, 480, 21, 20, 0, 0,
 	src_int32_20_21_2500_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_20_21_3125_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -574,3 +575,4 @@ const int32_t src_int32_20_21_3125_5000_fir[560] = {
 struct src_stage src_int32_20_21_3125_5000 = {
 	1, 1, 20, 28, 560, 21, 20, 0, 0,
 	src_int32_20_21_3125_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_20_21_4167_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -1134,3 +1135,4 @@ const int32_t src_int32_20_21_4167_5000_fir[1120] = {
 struct src_stage src_int32_20_21_4167_5000 = {
 	1, 1, 20, 56, 1120, 21, 20, 0, 0,
 	src_int32_20_21_4167_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_20_21_4535_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -2014,3 +2015,4 @@ const int32_t src_int32_20_21_4535_5000_fir[2000] = {
 struct src_stage src_int32_20_21_4535_5000 = {
 	1, 1, 20, 100, 2000, 21, 20, 0, 0,
 	src_int32_20_21_4535_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_20_7_2976_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -494,3 +495,4 @@ const int32_t src_int32_20_7_2976_5000_fir[480] = {
 struct src_stage src_int32_20_7_2976_5000 = {
 	1, 3, 20, 24, 480, 7, 20, 0, 0,
 	src_int32_20_7_2976_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_21_10_2500_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -434,3 +435,4 @@ const int32_t src_int32_21_10_2500_5000_fir[420] = {
 struct src_stage src_int32_21_10_2500_5000 = {
 	9, 19, 21, 20, 420, 10, 21, 0, 0,
 	src_int32_21_10_2500_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_21_10_3455_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -602,3 +603,4 @@ const int32_t src_int32_21_10_3455_5000_fir[588] = {
 struct src_stage src_int32_21_10_3455_5000 = {
 	9, 19, 21, 28, 588, 10, 21, 0, 0,
 	src_int32_21_10_3455_5000_fir};
+/** \endcond */

src/include/sof/audio/coefficients/src/src_ipc4_int32_21_10_4535_5000.h

@@ -4,6 +4,7 @@
  *
  */
 
+/** \cond GENERATED_BY_TOOLS_TUNE_SRC */
 #include <sof/audio/src/src.h>
 #include <stdint.h>
 
@@ -2030,3 +2031,4 @@ const int32_t src_int32_21_10_4535_5000_fir[2016] = {
 struct src_stage src_int32_21_10_4535_5000 = {
 	9, 19, 21, 96, 2016, 10, 21, 0, 0,
 	src_int32_21_10_4535_5000_fir};
+/** \endcond */