From 334a09b1cf7586bc76fe8e1ef7e1c20baafb5f5c Mon Sep 17 00:00:00 2001 From: Pedro Date: Wed, 4 Mar 2015 23:36:33 +0000 Subject: [PATCH] Add quickref.html to doxygen build site --- build/documentation/DoxygenLayout.xml | 3 ++- build/documentation/README.md | 4 ++-- build/documentation/build_docs.sh | 5 ++++- build/documentation/doxygen.cfg | 4 ++-- 4 files changed, 10 insertions(+), 6 deletions(-) diff --git a/build/documentation/DoxygenLayout.xml b/build/documentation/DoxygenLayout.xml index 1e11b43..e437cdd 100644 --- a/build/documentation/DoxygenLayout.xml +++ b/build/documentation/DoxygenLayout.xml @@ -3,7 +3,8 @@ - + + diff --git a/build/documentation/README.md b/build/documentation/README.md index fb83b9d..3a74b36 100644 --- a/build/documentation/README.md +++ b/build/documentation/README.md @@ -1,4 +1,4 @@ -# DOCUMENTATION HOW-TO +# Documentation HOW-TO **HTML Tidy** provides several types of documentation to suit different purposes. This document describes how to generate the following: @@ -92,7 +92,7 @@ but any XSLT processor of your choice should work, too. - This examples uses the `xsltproc` command to transform `tidy-help.xml` using the rules in the `tidy1.xsl` stylesheet, and output it to `tidy.1`. - Note that `tidy1.xls` includes the file `tidy-config.xml` as part of the stylesheet, + \note Note that `tidy1.xls` includes the file `tidy-config.xml` as part of the stylesheet, and so although it does not appear in the command invocation, it is indeed required. diff --git a/build/documentation/build_docs.sh b/build/documentation/build_docs.sh index 7d2dcc2..6106ac0 100755 --- a/build/documentation/build_docs.sh +++ b/build/documentation/build_docs.sh @@ -106,7 +106,10 @@ hash doxygen 2>/dev/null || { echo "- doxygen not found. This script requires do if [ "$BUILD_API" -eq 1 ]; then echo "The following is doxygen's stderr output. It doesn't indicate errors with this script:\n" - ( cat "$DOXY_CFG"; echo "PROJECT_NUMBER=$TIDY_VERSION" ) | doxygen - > /dev/null + ( cat "$DOXY_CFG"; \ + echo "PROJECT_NUMBER=$TIDY_VERSION"; \ + echo "HTML_EXTRA_FILES=$OUTP_DIR/quickref.html"; ) \ + | doxygen - > /dev/null echo "\nTidyLib API documentation has been built." else echo "* $OUTP_DIR/tidylib_api/ was skipped because not all dependencies were satisfied." diff --git a/build/documentation/doxygen.cfg b/build/documentation/doxygen.cfg index dbe2e22..7d046c5 100644 --- a/build/documentation/doxygen.cfg +++ b/build/documentation/doxygen.cfg @@ -624,7 +624,7 @@ WARNINGS = YES # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some @@ -665,7 +665,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = "../../include" +INPUT = "../../include" "./" # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is