emelie/tidy-html5
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add quickref.html to doxygen build site

Browse source
This commit is contained in:
Pedro 2015-03-04 23:36:33 +00:00
parent 1e60415120
commit 334a09b1cf
4 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
build/documentation/DoxygenLayout.xml
View file

@ -3,7 +3,8 @@
<!-- Navigation index tabs for HTML output --> <!-- Navigation index tabs for HTML output -->
<navindex> <navindex>
<tab type="mainpage" visible="yes" title=""/> <tab type="mainpage" visible="yes" title=""/>
<tab type="pages" visible="yes" title="" intro=""/> <tab type="user" url="quickref.html" title="Quick Ref"/>
<tab type="pages" visible="yes" title="Pages" intro=""/>
<tab type="modules" visible="yes" title="" intro=""/> <tab type="modules" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="yes" title=""> <tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/> <tab type="namespacelist" visible="yes" title="" intro=""/>

4
build/documentation/README.md
View file

@ -1,4 +1,4 @@
# DOCUMENTATION HOW-TO # Documentation HOW-TO
**HTML Tidy** provides several types of documentation to suit different purposes. This **HTML Tidy** provides several types of documentation to suit different purposes. This
document describes how to generate the following: 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 - 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`. 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. and so although it does not appear in the command invocation, it is indeed required.

5
build/documentation/build_docs.sh
View file

@ -106,7 +106,10 @@ hash doxygen 2>/dev/null || { echo "- doxygen not found. This script requires do
if [ "$BUILD_API" -eq 1 ]; then if [ "$BUILD_API" -eq 1 ]; then
echo "The following is doxygen's stderr output. It doesn't indicate errors with this script:\n" 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." echo "\nTidyLib API documentation has been built."
else else
echo "* $OUTP_DIR/tidylib_api/ was skipped because not all dependencies were satisfied." echo "* $OUTP_DIR/tidylib_api/ was skipped because not all dependencies were satisfied."

4
build/documentation/doxygen.cfg
View file

@ -624,7 +624,7 @@ WARNINGS = YES
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled. # 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 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some # 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 # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = "../../include" INPUT = "../../include" "./"
# This tag can be used to specify the character encoding of the source files # 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 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is