Merge branch 'doxygen-undoc-param' into 'master'

[ci] Catch undocumented parameter in Doxygen output.

See merge request ogs/ogs!3784

ProcessLib/ComponentTransport/CreateComponentTransportProcess.cpp

@@ -231,7 +231,7 @@ std::unique_ptr<Process> createComponentTransportProcess(
         MaterialPropertyLib::createMaterialSpatialDistributionMap(media, mesh);
 
     auto lookup_table = ComponentTransport::createLookupTable(
-        //! \ogs_file_param_special{prj__processes__process__ComponentTransport__tabular_file}
+        //! \ogs_file_param{prj__processes__process__ComponentTransport__tabular_file}
         config.getConfigParameterOptional<std::string>("tabular_file"),
         process_variables);
 

scripts/ci/jobs/build-docs.yml

@@ -37,6 +37,7 @@ build docs:
     - cmake . --graphviz=cmake-dependencies.dot && dot -Tsvg cmake-dependencies.dot -o cmake-dependencies.svg
     - cmake . -DOGS_BUILD_PROCESSES=SteadyStateDiffusion
     - cmake --build . --target doc > >(tee make-docs.output)
+    - grep 'warning:' make-docs.output >> DoxygenWarnings.log || true
     - cat DoxygenWarnings.log|grep -v 'too many nodes'
     - NUM_DOX_WARNINGS=`cat DoxygenWarnings.log|grep warning:|grep -v 'too many nodes'|wc -l|xargs`
     - echo "doxygen_warnings $NUM_DOX_WARNINGS" >> metrics.txt
@@ -70,6 +71,7 @@ build docs:
     expire_in: 1 week
     reports:
       metrics: build/metrics.txt
+    when: always
 
 check docs links:
   stage: check

scripts/doc/check-project-params.py

@@ -137,6 +137,10 @@ if undocumented:
                 + "| [→ ufz/ogs/master]({6}/{0}#L{1})"
             ).format(*u2)
         )
+        print(
+            "warning: undocumented parameter in {0}, line {1}: {3}".format(*u2),
+            file=sys.stderr,
+        )
 
 if unneeded_comments:
     qa_status_succeeded = False