From 895411023216905525a35bdd6fb819d07658cc8a Mon Sep 17 00:00:00 2001 From: Pedro Date: Thu, 5 Mar 2015 20:35:51 +0000 Subject: [PATCH] add link to modules and fix tidy5 example --- build/documentation/DoxygenLayout.xml | 1 + build/documentation/build_docs.sh | 2 +- build/documentation/tidy_docs.dox | 10 ++++++---- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/build/documentation/DoxygenLayout.xml b/build/documentation/DoxygenLayout.xml index a90dcf7..9deb824 100644 --- a/build/documentation/DoxygenLayout.xml +++ b/build/documentation/DoxygenLayout.xml @@ -21,6 +21,7 @@ + diff --git a/build/documentation/build_docs.sh b/build/documentation/build_docs.sh index 808615b..bdf038a 100755 --- a/build/documentation/build_docs.sh +++ b/build/documentation/build_docs.sh @@ -119,7 +119,7 @@ if [ "$BUILD_API" -eq 1 ]; then # - which are then passed to doxygen as stdin (instead of the path to a config.file) ( cat "$DOXY_CFG"; \ echo "PROJECT_NUMBER=$TIDY_VERSION"; \ - echo "HTML_EXTRA_FILES=$OUTP_DIR/quickref.html ./tidy5.cmd.txt"; ) \ + echo "HTML_EXTRA_FILES=$OUTP_DIR/quickref.html ./examples/tidy5.cmd.txt"; ) \ | doxygen - > /dev/null echo "\nTidyLib API documentation has been built." else diff --git a/build/documentation/tidy_docs.dox b/build/documentation/tidy_docs.dox index 69f107e..cdaed30 100644 --- a/build/documentation/tidy_docs.dox +++ b/build/documentation/tidy_docs.dox @@ -6,18 +6,20 @@

What is tidy ?

-- \b `tidy` - - is a console application for Mac OS X, Linux, Windows, UNIX, and more. - - It corrects and cleans up HTML and XML documents by fixing markup errors and upgrading legacy code to modern standards. -- \b `tidylib` +- \ref tidylib - is a C static or dynamic library that developers can integrate into their applications in order to bring all of Tidy’s power to your favorite tools. - `tidylib` is used today in desktop applications, web servers, and more. + +- \ref tidy5_cmd + - is a console application built on \ref tidylib for Mac OS X, Linux, Windows, UNIX, and more. + - It corrects and cleans up HTML and XML documents by fixing markup errors and upgrading legacy code to modern standards. \section content Contents - \ref tidy5_cmd - \ref tidylib + - Modules - \ref building_tidy - \ref history - \ref license