commit 885efc162f232661b6e270fff7914fbc4127c295 parent 28ad40aeb31aebb6bd8bce94f1755f1a9de270b1 Author: Florian Dold <dold@taler.net> Date: Tue, 8 Sep 2026 20:41:33 +0200 doxygen: generate CI documentation and propagate errors Invoke the Meson documentation target so version.doxy is generated before Doxygen runs. Build full documentation instead of printing Makefile help, and stop the helper when a command fails. Remove invalid file annotation paths and render the external curl helper reference as code so strict documentation generation can complete. Diffstat:
23 files changed, 25 insertions(+), 27 deletions(-)
diff --git a/contrib/ci/jobs/3-docs/docs.sh b/contrib/ci/jobs/3-docs/docs.sh @@ -4,8 +4,4 @@ set -exuo pipefail ./bootstrap ./configure --enable-only-doc -pushd ./doc/doxygen/ - -make full - -popd +make doxygen diff --git a/scripts/doxygen.meson.sh b/scripts/doxygen.meson.sh @@ -1,5 +1,7 @@ #!/bin/sh +set -eu + # This is more portable than `which' but comes with # the caveat of not(?) properly working on busybox's ash: existence() @@ -13,6 +15,6 @@ if ! existence doxygen; then fi cd "${MESON_SOURCE_ROOT}/doc/doxygen" echo "PROJECT_NUMBER = ${PACKAGE_VERSION}" > version.doxy -make all +make full echo "Doxygen files generated into ${MESON_SOURCE_ROOT}/doc/doxygen!" diff --git a/src/include/donau-database/commit.h b/src/include/donau-database/commit.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/commit.h + * @file * @brief implementation of the commit function for Postgres * @author Christian Grothoff */ diff --git a/src/include/donau-database/create_tables.h b/src/include/donau-database/create_tables.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/create_tables.h + * @file * @brief implementation of the create_tables function for Postgres * @author Johannes Casaburi */ diff --git a/src/include/donau-database/do_insert_receipt_issued.h b/src/include/donau-database/do_insert_receipt_issued.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/do_do_insert_receipt_issued.h + * @file * @brief implementation of the do_insert_receipt_issued function for Postgres * @author Johannes Casaburi */ diff --git a/src/include/donau-database/drop_tables.h b/src/include/donau-database/drop_tables.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/drop_tables.h + * @file * @brief implementation of the drop_tables function for Postgres * @author Christian Grothoff */ diff --git a/src/include/donau-database/event_listen.h b/src/include/donau-database/event_listen.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/event_listen.h + * @file * @brief implementation of the event_listen function for Postgres * @author Christian Grothoff */ diff --git a/src/include/donau-database/event_listen_cancel.h b/src/include/donau-database/event_listen_cancel.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/event_listen_cancel.h + * @file * @brief implementation of the event_listen_cancel function for Postgres * @author Christian Grothoff */ diff --git a/src/include/donau-database/event_notify.h b/src/include/donau-database/event_notify.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/event_notify.h + * @file * @brief implementation of the event_notify function for Postgres * @author Christian Grothoff */ diff --git a/src/include/donau-database/iterate_active_signkeys.h b/src/include/donau-database/iterate_active_signkeys.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/iterate_active_signkeys.h + * @file * @brief implementation of the iterate_active_signkeys function for Postgres * @author Johannes Casaburi */ diff --git a/src/include/donau-database/preflight.h b/src/include/donau-database/preflight.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/preflight.h + * @file * @brief implementation of the preflight function for Postgres * @author Christian Grothoff */ diff --git a/src/include/donau-database/rollback.h b/src/include/donau-database/rollback.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/rollback.h + * @file * @brief implementation of the rollback function for Postgres * @author Christian Grothoff */ diff --git a/src/include/donau-database/start.h b/src/include/donau-database/start.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/start.h + * @file * @brief implementation of the start function for Postgres * @author Christian Grothoff */ diff --git a/src/include/donau-database/start_read_committed.h b/src/include/donau-database/start_read_committed.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/start_read_committed.h + * @file * @brief implementation of the start_read_committed function for Postgres * @author Christian Grothoff */ diff --git a/src/include/donau-database/start_read_only.h b/src/include/donau-database/start_read_only.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file src/include/donau-database/start_read_only.h + * @file * @brief implementation of the start_read_only function for Postgres * @author Christian Grothoff */ diff --git a/src/include/donau_service.h b/src/include/donau_service.h @@ -53,7 +53,7 @@ enum DONAU_GlobalOptions /** * Allow the use of HTTP/2 and HTTP/3. Note that HTTP/3 is only * actually enabled if the libcurl we run against is deemed suitable - * (see #TALER_curl_set_http_version()). Ignored if + * (see \c TALER_curl_set_http_version()). Ignored if * #DONAU_GO_FORCE_HTTP1_1 is also set. */ DONAU_GO_ENABLE_HTTP3 = 2, diff --git a/src/json/json_pack.c b/src/json/json_pack.c @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file donau/src/json/json_pack.c + * @file * @brief helper functions for JSON object packing * @author Christian Grothoff * @author Lukas Matyja diff --git a/src/pq/pq_common.h b/src/pq/pq_common.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file donau/src/pq/pq_common.h + * @file * @brief common defines for the pq functions * @author Johannes Casaburi */ diff --git a/src/pq/pq_query_helper.c b/src/pq/pq_query_helper.c @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file donau/src/pq/pq_query_helper.c + * @file * @brief helper functions for Taler-specific libpq (PostGres) interactions * @author Johannes Casaburi */ diff --git a/src/pq/pq_result_helper.c b/src/pq/pq_result_helper.c @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ /** - * @file donau/src/pq/pq_result_helper.c + * @file * @brief functions to initialize parameter arrays * @author Johannes Casaburi */ diff --git a/src/testing/testing_api_loop.c b/src/testing/testing_api_loop.c @@ -18,7 +18,7 @@ */ /** - * @file donau/src/testing/testing_api_loop.c + * @file * @brief main interpreter loop for testcases * @author Lukas Matyja */ diff --git a/src/testing/testing_api_misc.c b/src/testing/testing_api_misc.c @@ -17,7 +17,7 @@ <http://www.gnu.org/licenses/> */ /** - * @file donau/src/testing/testing_api_misc.c + * @file * @brief non-command functions useful for writing tests * @author Christian Grothoff */ diff --git a/src/testing/testing_api_traits.c b/src/testing/testing_api_traits.c @@ -17,7 +17,7 @@ <http://www.gnu.org/licenses/> */ /** - * @file donau/src/testing/testing_api_traits.c + * @file * @brief loop for trait resolution * @author Christian Grothoff * @author Marcello Stanisci