|
| 1 | +From 6ad5b6a9ce81383ef75e6f7b88f54d3c29294e63 Mon Sep 17 00:00:00 2001 |
| 2 | +From: Michael Opdenacker < [email protected]> |
| 3 | +Date: Sat, 15 Mar 2025 11:50:08 +0100 |
| 4 | +Subject: [PATCH] API documentation: replace modules.html by topics.html |
| 5 | + |
| 6 | +This fixes the issue reported on |
| 7 | +https://lists.xiph.org/pipermail/flac-dev/2025-February/006696.html |
| 8 | + |
| 9 | +Newer Doxygen versions call what was previously api/modules.html |
| 10 | +api/topics.html instead. |
| 11 | + |
| 12 | +Signed-off-by: Michael Opdenacker < [email protected]> |
| 13 | +Suggested-by: Christian Weisgerber < [email protected]> |
| 14 | +Upstream-Status: Submitted [ [email protected]] |
| 15 | +--- |
| 16 | + configure.ac | 2 +- |
| 17 | + include/FLAC/all.h | 2 +- |
| 18 | + 2 files changed, 2 insertions(+), 2 deletions(-) |
| 19 | + |
| 20 | +diff --git a/configure.ac b/configure.ac |
| 21 | +index 8eb82320..74295eec 100644 |
| 22 | +--- a/configure.ac |
| 23 | ++++ b/configure.ac |
| 24 | +@@ -296,7 +296,7 @@ if test "x$enable_doxygen_docs" != xfalse ; then |
| 25 | + fi |
| 26 | + AM_CONDITIONAL(FLaC__HAS_DOXYGEN, test -n "$DOXYGEN") |
| 27 | + |
| 28 | +-if test ! -n "$DOXYGEN" && test -f "$srcdir/doc/FLAC.tag" && test -f "$srcdir/doc/api/modules.html" ; then |
| 29 | ++if test ! -n "$DOXYGEN" && test -f "$srcdir/doc/FLAC.tag" && test -f "$srcdir/doc/api/topics.html" ; then |
| 30 | + HAS_PREBUILT_DOXYGEN=yes |
| 31 | + fi |
| 32 | + AM_CONDITIONAL(FLaC__HAS_PREBUILT_DOXYGEN, test "x$HAS_PREBUILT_DOXYGEN" = xyes) |
| 33 | +diff --git a/include/FLAC/all.h b/include/FLAC/all.h |
| 34 | +index f29aa010..0be26fd7 100644 |
| 35 | +--- a/include/FLAC/all.h |
| 36 | ++++ b/include/FLAC/all.h |
| 37 | +@@ -102,7 +102,7 @@ |
| 38 | + * \section getting_started Getting Started |
| 39 | + * |
| 40 | + * A good starting point for learning the API is to browse through |
| 41 | +- * the <A HREF="modules.html">modules</A>. Modules are logical |
| 42 | ++ * the <A HREF="topics.html">modules</A>. Modules are logical |
| 43 | + * groupings of related functions or classes, which correspond roughly |
| 44 | + * to header files or sections of header files. Each module includes a |
| 45 | + * detailed description of the general usage of its functions or |
0 commit comments