diff options
| author | Jia Tan <jiat0218@gmail.com> | 2023-03-17 01:30:36 +0800 |
|---|---|---|
| committer | Jia Tan <jiat0218@gmail.com> | 2023-03-17 20:19:16 +0800 |
| commit | 896295117324f323c0b8db6a31ad6ebfaa88793d (patch) | |
| tree | a8484e20aa6635dc48a8ec2b04bf8614885470bc /doxygen | |
| parent | liblzma: Remove note from lzma_options_bcj about the ARM64 exception. (diff) | |
| download | xz-896295117324f323c0b8db6a31ad6ebfaa88793d.tar.xz | |
Doc: Rename Doxygen HTML doc directory name liblzma => api.
When the docs are installed, calling the directory "liblzma" is
confusing since multiple other files in the doc directory are for
liblzma. This should also make it more natural for distros when they
package the documentation.
Diffstat (limited to 'doxygen')
| -rw-r--r-- | doxygen/Doxyfile | 2 | ||||
| -rwxr-xr-x | doxygen/update-doxygen | 18 |
2 files changed, 10 insertions, 10 deletions
diff --git a/doxygen/Doxyfile b/doxygen/Doxyfile index f18d18cd..20afb528 100644 --- a/doxygen/Doxyfile +++ b/doxygen/Doxyfile @@ -1209,7 +1209,7 @@ GENERATE_HTML = YES # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_OUTPUT = liblzma +HTML_OUTPUT = api # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). diff --git a/doxygen/update-doxygen b/doxygen/update-doxygen index e5f3ab43..a5103199 100755 --- a/doxygen/update-doxygen +++ b/doxygen/update-doxygen @@ -45,16 +45,16 @@ PACKAGE_VERSION=`cd .. && sh build-aux/version.sh` || exit 1 # If no arguments are specified, default to generating liblzma API header # documentation only. case $1 in - '' | liblzma) + '' | api) # Remove old documentation before re-generating the new. - rm -rf ../doc/liblzma + rm -rf ../doc/api # Generate the HTML documentation by preparing the Doxyfile # in stdin and piping the result to the doxygen command. # With Doxygen, the last assignment of a value to a tag will # override any earlier assignment. So, we can use this # feature to override the tags that need to change between - # "liblzma" and "internal" modes. + # "api" and "internal" modes. ( cat Doxyfile echo "PROJECT_NUMBER = $PACKAGE_VERSION" @@ -70,14 +70,14 @@ case $1 in # itself, and doesn't include the actual license text (it # only refers to the MIT license by name). echo "Stripping JavaScript from Doxygen output..." - for F in ../doc/liblzma/*.html + for F in ../doc/api/*.html do sed 's/<script [^>]*><\/script>//g s/onclick="[^"]*"//g' \ - "$F" > ../doc/liblzma/tmp - mv -f ../doc/liblzma/tmp "$F" + "$F" > ../doc/api/tmp + mv -f ../doc/api/tmp "$F" done - rm -f ../doc/liblzma/*.js + rm -f ../doc/api/*.js ;; internal) @@ -102,8 +102,8 @@ case $1 in echo "doxygen/update-doxygen: Error: mode argument '$1'" \ "is not supported." >&2 echo "doxygen/update-doxygen: Supported modes:" >&2 - echo "doxygen/update-doxygen: - 'liblzma' (default):" \ - "API docs into doc/liblzma" >&2 + echo "doxygen/update-doxygen: - 'api' (default):" \ + "liblzma API docs into doc/api" >&2 echo "doxygen/update-doxygen: - 'internal':"\ "internal docs into doc/internal" >&2 exit 1 |