|
Than Ngo |
248e03 |
commit 31cf78d223e52fe078ad9b0651672aeb73926065
|
|
Than Ngo |
248e03 |
Author: albert-github <albert.tests@gmail.com>
|
|
Than Ngo |
248e03 |
Date: Sun Jun 4 12:52:50 2017 +0200
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
Correction of non reachable links and redirected links in documentation.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
The W3C link checker reported a number of problems regarding non reachable links and permanent redirects.
|
|
Than Ngo |
248e03 |
Most of these problems have been fixed with this patch
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
diff --git a/doc/commands.doc b/doc/commands.doc
|
|
Than Ngo |
248e03 |
index 70b89c60..4357fba1 100644
|
|
Than Ngo |
248e03 |
--- a/doc/commands.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/commands.doc
|
|
Than Ngo |
248e03 |
@@ -433,7 +433,7 @@ Structural indicators
|
|
Than Ngo |
248e03 |
\par Example:
|
|
Than Ngo |
248e03 |
\include enum.h
|
|
Than Ngo |
248e03 |
\htmlonly
|
|
Than Ngo |
248e03 |
- Click here
|
|
Than Ngo |
248e03 |
+ Click here
|
|
Than Ngo |
248e03 |
for the corresponding HTML documentation that is generated by doxygen.
|
|
Than Ngo |
248e03 |
\endhtmlonly
|
|
Than Ngo |
248e03 |
\latexonly
|
|
Than Ngo |
248e03 |
@@ -565,7 +565,7 @@ Structural indicators
|
|
Than Ngo |
248e03 |
\par Example:
|
|
Than Ngo |
248e03 |
\include func.h
|
|
Than Ngo |
248e03 |
\htmlonly
|
|
Than Ngo |
248e03 |
- Click here
|
|
Than Ngo |
248e03 |
+ Click here
|
|
Than Ngo |
248e03 |
for the corresponding HTML documentation that is generated by doxygen.
|
|
Than Ngo |
248e03 |
\endhtmlonly
|
|
Than Ngo |
248e03 |
\latexonly
|
|
Than Ngo |
248e03 |
@@ -823,7 +823,7 @@ Structural indicators
|
|
Than Ngo |
248e03 |
\par Example:
|
|
Than Ngo |
248e03 |
\include overload.cpp
|
|
Than Ngo |
248e03 |
\htmlonly
|
|
Than Ngo |
248e03 |
- Click here
|
|
Than Ngo |
248e03 |
+ Click here
|
|
Than Ngo |
248e03 |
for the corresponding HTML documentation that is generated by doxygen.
|
|
Than Ngo |
248e03 |
\endhtmlonly
|
|
Than Ngo |
248e03 |
\latexonly
|
|
Than Ngo |
248e03 |
@@ -1121,7 +1121,7 @@ Structural indicators
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
\section cmdweakgroup \\weakgroup <name> [(title)]
|
|
Than Ngo |
248e03 |
- \addindex \\addtogroup
|
|
Than Ngo |
248e03 |
+ \addindex \\weakgroup
|
|
Than Ngo |
248e03 |
Can be used exactly like \ref cmdaddtogroup "\\addtogroup", but has
|
|
Than Ngo |
248e03 |
a lower priority when it comes to resolving conflicting grouping
|
|
Than Ngo |
248e03 |
definitions.
|
|
Than Ngo |
248e03 |
@@ -1513,7 +1513,7 @@ ALIASES = "english=\if english" \
|
|
Than Ngo |
248e03 |
\par Example:
|
|
Than Ngo |
248e03 |
\include par.cpp
|
|
Than Ngo |
248e03 |
\htmlonly
|
|
Than Ngo |
248e03 |
- Click here
|
|
Than Ngo |
248e03 |
+ Click here
|
|
Than Ngo |
248e03 |
for the corresponding HTML documentation that is generated by doxygen.
|
|
Than Ngo |
248e03 |
\endhtmlonly
|
|
Than Ngo |
248e03 |
\latexonly
|
|
Than Ngo |
248e03 |
@@ -2704,7 +2704,7 @@ class Receiver
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
\addindex \\startuml
|
|
Than Ngo |
248e03 |
Starts a text fragment which should contain a valid description of a
|
|
Than Ngo |
248e03 |
- PlantUML diagram. See http://plantuml.sourceforge.net/ for examples.
|
|
Than Ngo |
248e03 |
+ PlantUML diagram. See http://plantuml.com/ for examples.
|
|
Than Ngo |
248e03 |
The text fragment ends with \ref cmdenduml "\\enduml".
|
|
Than Ngo |
248e03 |
\note You need to install Java and the PlantUML's jar file,
|
|
Than Ngo |
248e03 |
if you want to use this command. The location of the jar file should be specified
|
|
Than Ngo |
248e03 |
diff --git a/doc/customize.doc b/doc/customize.doc
|
|
Than Ngo |
248e03 |
index f98ce0b4..9ef38919 100644
|
|
Than Ngo |
248e03 |
--- a/doc/customize.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/customize.doc
|
|
Than Ngo |
248e03 |
@@ -90,7 +90,7 @@ that are disabled by default:
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
To tweak things like fonts or colors, margins, or other look \& feel
|
|
Than Ngo |
248e03 |
aspects of the HTML output in detail, you can create a different
|
|
Than Ngo |
248e03 |
-cascading style sheet.
|
|
Than Ngo |
248e03 |
+cascading style sheet.
|
|
Than Ngo |
248e03 |
You can also let doxygen use a custom header and footer for each HTML
|
|
Than Ngo |
248e03 |
page it generates, for instance to make the output conform to the style
|
|
Than Ngo |
248e03 |
used on the rest of your web site.
|
|
Than Ngo |
248e03 |
@@ -390,7 +390,7 @@ files as one big DOM tree would not fit into memory.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
See the Breathe project for
|
|
Than Ngo |
248e03 |
an example that uses doxygen XML output from Python to bridge it with the
|
|
Than Ngo |
248e03 |
-Sphinx document generator.
|
|
Than Ngo |
248e03 |
+Sphinx document generator.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
\htmlonly
|
|
Than Ngo |
248e03 |
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
|
|
Than Ngo |
248e03 |
index f0499c6f..81cfdd08 100644
|
|
Than Ngo |
248e03 |
--- a/doc/docblocks.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/docblocks.doc
|
|
Than Ngo |
248e03 |
@@ -260,7 +260,7 @@ Here is an example of the use of these comment blocks:
|
|
Than Ngo |
248e03 |
\include afterdoc.h
|
|
Than Ngo |
248e03 |
\htmlonly
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
- Click here
|
|
Than Ngo |
248e03 |
+ Click here
|
|
Than Ngo |
248e03 |
for the corresponding HTML documentation that is generated by doxygen.
|
|
Than Ngo |
248e03 |
\endhtmlonly
|
|
Than Ngo |
248e03 |
\latexonly
|
|
Than Ngo |
248e03 |
@@ -281,7 +281,7 @@ Here is an example of a documented piece of C++ code using the Qt style:
|
|
Than Ngo |
248e03 |
\include qtstyle.cpp
|
|
Than Ngo |
248e03 |
\htmlonly
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
- Click here
|
|
Than Ngo |
248e03 |
+ Click here
|
|
Than Ngo |
248e03 |
for the corresponding HTML documentation that is generated by doxygen.
|
|
Than Ngo |
248e03 |
\endhtmlonly
|
|
Than Ngo |
248e03 |
\latexonly
|
|
Than Ngo |
248e03 |
@@ -316,7 +316,7 @@ JavaDoc style and \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" set to YES:
|
|
Than Ngo |
248e03 |
\include jdstyle.cpp
|
|
Than Ngo |
248e03 |
\htmlonly
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
- Click here
|
|
Than Ngo |
248e03 |
+ Click here
|
|
Than Ngo |
248e03 |
for the corresponding HTML documentation that is generated by doxygen.
|
|
Than Ngo |
248e03 |
\endhtmlonly
|
|
Than Ngo |
248e03 |
\latexonly
|
|
Than Ngo |
248e03 |
@@ -634,7 +634,7 @@ need for some more structure, like a block of verbatim text, a list, or a
|
|
Than Ngo |
248e03 |
simple table. For this doxygen supports the
|
|
Than Ngo |
248e03 |
Markdown
|
|
Than Ngo |
248e03 |
syntax, including parts of the
|
|
Than Ngo |
248e03 |
-Markdown Extra
|
|
Than Ngo |
248e03 |
+Markdown Extra
|
|
Than Ngo |
248e03 |
extension.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
Markdown is designed to be very easy to read and write.
|
|
Than Ngo |
248e03 |
@@ -646,13 +646,13 @@ directly. For more details see chapter \ref markdown.
|
|
Than Ngo |
248e03 |
For programming language specific formatting doxygen has two
|
|
Than Ngo |
248e03 |
forms of additional markup on top of Markdown formatting.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
-1. Javadoc like markup.
|
|
Than Ngo |
248e03 |
+1. Javadoc like markup.
|
|
Than Ngo |
248e03 |
See \ref commands for a complete overview of all commands supported by doxygen.
|
|
Than Ngo |
248e03 |
-2. XML markup
|
|
Than Ngo |
248e03 |
+2. XML markup
|
|
Than Ngo |
248e03 |
as specified in the C# standard. See \ref xmlcmds for the XML commands supported by doxygen.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
If this is still not enough doxygen also supports a \ref htmlcmds "subset" of
|
|
Than Ngo |
248e03 |
-the HTML markup language.
|
|
Than Ngo |
248e03 |
+the HTML markup language.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
\htmlonly
|
|
Than Ngo |
248e03 |
Go to the next section or return to the
|
|
Than Ngo |
248e03 |
diff --git a/doc/extsearch.doc b/doc/extsearch.doc
|
|
Than Ngo |
248e03 |
index cead851c..99a72195 100644
|
|
Than Ngo |
248e03 |
--- a/doc/extsearch.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/extsearch.doc
|
|
Than Ngo |
248e03 |
@@ -52,7 +52,7 @@ The data flow is shown in the following diagram:
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
The first step is to make the search engine available via a web server.
|
|
Than Ngo |
248e03 |
If you use `doxysearch.cgi` this means making the
|
|
Than Ngo |
248e03 |
-CGI binary
|
|
Than Ngo |
248e03 |
+CGI binary
|
|
Than Ngo |
248e03 |
available from the web server (i.e. be able to run it from a
|
|
Than Ngo |
248e03 |
browser via an URL starting with http:)
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
@@ -187,7 +187,7 @@ The next subsections describe these interfaces in more detail.
|
|
Than Ngo |
248e03 |
\subsection extsearch_api_index Indexer input format
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
The search data produced by doxygen follows the
|
|
Than Ngo |
248e03 |
-Solr XML index message
|
|
Than Ngo |
248e03 |
+Solr XML index message
|
|
Than Ngo |
248e03 |
format.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
The input for the indexer is an XML file, which consists of one `<add>` tag containing
|
|
Than Ngo |
248e03 |
@@ -224,12 +224,12 @@ Each field has a name. The following field names are supported:
|
|
Than Ngo |
248e03 |
- *text*: the documentation associated with the item. Note that only words are present, no markup.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
@note Due to the potentially large size of the XML file, it is recommended to use a
|
|
Than Ngo |
248e03 |
-SAX based parser to process it.
|
|
Than Ngo |
248e03 |
+SAX based parser to process it.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
\subsection extsearch_api_search_in Search URL format
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
When the search engine is invoked from a doxygen generated HTML page, a number of parameters are
|
|
Than Ngo |
248e03 |
-passed to via the query string.
|
|
Than Ngo |
248e03 |
+passed to via the query string.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
The following fields are passed:
|
|
Than Ngo |
248e03 |
- *q*: the query text as entered by the user
|
|
Than Ngo |
248e03 |
@@ -247,14 +247,14 @@ It represents a query for the word 'list' (`q=list`) requesting 20 search result
|
|
Than Ngo |
248e03 |
starting with the result number 20 (`p=1`) and using callback 'dummy' (`cb=dummy`):
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
-@note The values are URL encoded so they
|
|
Than Ngo |
248e03 |
+@note The values are URL encoded so they
|
|
Than Ngo |
248e03 |
have to be decoded before they can be used.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
\subsection extsearch_api_search_out Search results format
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
When invoking the search engine as shown in the previous subsection, it should reply with
|
|
Than Ngo |
248e03 |
the results. The format of the reply is
|
|
Than Ngo |
248e03 |
-JSON with padding, which is basically
|
|
Than Ngo |
248e03 |
+JSON with padding, which is basically
|
|
Than Ngo |
248e03 |
a javascript struct wrapped in a function call. The name of function should be the name of
|
|
Than Ngo |
248e03 |
the callback (as passed with the *cb* field in the query).
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
diff --git a/doc/faq.doc b/doc/faq.doc
|
|
Than Ngo |
248e03 |
index 5af3db83..bbad8c0f 100644
|
|
Than Ngo |
248e03 |
--- a/doc/faq.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/faq.doc
|
|
Than Ngo |
248e03 |
@@ -285,7 +285,7 @@ At the time I was looking into \c lex and \c yacc, where a lot of things start w
|
|
Than Ngo |
248e03 |
\section faq_why What was the reason to develop doxygen?
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
I once wrote a GUI widget based on the Qt library (it is still available at
|
|
Than Ngo |
248e03 |
-http://sourceforge.net/projects/qdbttabular/ but hasn't been updated since 2002).
|
|
Than Ngo |
248e03 |
+https://sourceforge.net/projects/qdbttabular/ but hasn't been updated since 2002).
|
|
Than Ngo |
248e03 |
Qt had nicely generated documentation (using an internal tool which
|
|
Than Ngo |
248e03 |
they didn't want to release)
|
|
Than Ngo |
248e03 |
and I wrote similar docs by hand.
|
|
Than Ngo |
248e03 |
diff --git a/doc/formulas.doc b/doc/formulas.doc
|
|
Than Ngo |
248e03 |
index 650751e8..1649c197 100644
|
|
Than Ngo |
248e03 |
--- a/doc/formulas.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/formulas.doc
|
|
Than Ngo |
248e03 |
@@ -30,7 +30,7 @@ have the following tools installed
|
|
Than Ngo |
248e03 |
to bitmaps. I have used Aladdin GhostScript 8.0 for testing.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
For the HTML output there is also an alternative solution using
|
|
Than Ngo |
248e03 |
-MathJax which does not
|
|
Than Ngo |
248e03 |
+MathJax which does not
|
|
Than Ngo |
248e03 |
require the above tools. If you enable \ref cfg_use_mathjax "USE_MATHJAX" in
|
|
Than Ngo |
248e03 |
the config then the latex formulas will be copied to the HTML "as is" and a
|
|
Than Ngo |
248e03 |
client side javascript will parse them and turn them into (interactive) images.
|
|
Than Ngo |
248e03 |
diff --git a/doc/grouping.doc b/doc/grouping.doc
|
|
Than Ngo |
248e03 |
index bbb577cf..2c4ebe19 100644
|
|
Than Ngo |
248e03 |
--- a/doc/grouping.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/grouping.doc
|
|
Than Ngo |
248e03 |
@@ -197,7 +197,7 @@ documentation of the class.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
\htmlonly
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
-Click here
|
|
Than Ngo |
248e03 |
+Click here
|
|
Than Ngo |
248e03 |
for the corresponding HTML documentation that is generated by doxygen.
|
|
Than Ngo |
248e03 |
\endhtmlonly
|
|
Than Ngo |
248e03 |
\latexonly
|
|
Than Ngo |
248e03 |
diff --git a/doc/index.doc b/doc/index.doc
|
|
Than Ngo |
248e03 |
index c8950c4c..14f03961 100644
|
|
Than Ngo |
248e03 |
--- a/doc/index.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/index.doc
|
|
Than Ngo |
248e03 |
@@ -180,7 +180,7 @@ Thanks go to:
|
|
Than Ngo |
248e03 |
Talin for adding support for C# style comments with XML markup.
|
|
Than Ngo |
248e03 |
Petr Prikryl for coordinating the internationalization support.
|
|
Than Ngo |
248e03 |
All language maintainers for providing translations into many languages.
|
|
Than Ngo |
248e03 |
-The band Porcupine Tree for
|
|
Than Ngo |
248e03 |
+The band Porcupine Tree for
|
|
Than Ngo |
248e03 |
providing hours of great music to listen to while coding.
|
|
Than Ngo |
248e03 |
many, many others for suggestions, patches and bug reports.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
diff --git a/doc/install.doc b/doc/install.doc
|
|
Than Ngo |
248e03 |
index fd4f28d1..22d6e7cc 100644
|
|
Than Ngo |
248e03 |
--- a/doc/install.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/install.doc
|
|
Than Ngo |
248e03 |
@@ -37,7 +37,7 @@ following to build the executable:
|
|
Than Ngo |
248e03 |
\addindex strip
|
|
Than Ngo |
248e03 |
\addindex python
|
|
Than Ngo |
248e03 |
In order to generate a \c Makefile for your platform, you need
|
|
Than Ngo |
248e03 |
- cmake version 2.8.12 or later.
|
|
Than Ngo |
248e03 |
+ cmake version 2.8.12 or later.
|
|
Than Ngo |
248e03 |
\addindex cmake
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
@@ -63,7 +63,7 @@ tools should be installed.
|
|
Than Ngo |
248e03 |
For formulas in the HTML output (when MathJax is not used)
|
|
Than Ngo |
248e03 |
or in case you do not wish to use `pdflatex,
|
|
Than Ngo |
248e03 |
the ghostscript interpreter is needed. You can find it at
|
|
Than Ngo |
248e03 |
- www.ghostscript.com.
|
|
Than Ngo |
248e03 |
+ www.ghostscript.com.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
Compilation is now done by performing the following steps:
|
|
Than Ngo |
248e03 |
@@ -150,20 +150,20 @@ standard installation procedure that is required for these packages.
|
|
Than Ngo |
248e03 |
\section install_src_windows Compiling from source on Windows
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
From version 1.8.10 onwards, build files need to be generated by cmake.
|
|
Than Ngo |
248e03 |
-cmake can be downloaded from http://www.cmake.org/download/
|
|
Than Ngo |
248e03 |
+cmake can be downloaded from https://cmake.org/download/
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
At the moment only the express version of Visual Studio 2013 is tested,
|
|
Than Ngo |
248e03 |
but other version might also work.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
Alternatively, you can compile doxygen
|
|
Than Ngo |
248e03 |
\ref install_src_unix "the UNIX way" using
|
|
Than Ngo |
248e03 |
-Cygwin
|
|
Than Ngo |
248e03 |
+Cygwin
|
|
Than Ngo |
248e03 |
or MinGW.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
The next step is to install modern versions of \c bison and \c flex
|
|
Than Ngo |
248e03 |
-(see http://sourceforge.net/projects/winflexbison. After installation and adding them to
|
|
Than Ngo |
248e03 |
+(see https://sourceforge.net/projects/winflexbison/. After installation and adding them to
|
|
Than Ngo |
248e03 |
your `path` rename `win_flex.exe` to `flex.exe` and `win_bison.exe` to `bison.exe`)
|
|
Than Ngo |
248e03 |
-Furthermore you have to install \c python (version 2.6 or higher, see http://www.python.org).
|
|
Than Ngo |
248e03 |
+Furthermore you have to install \c python (version 2.6 or higher, see https://www.python.org).
|
|
Than Ngo |
248e03 |
These packages are needed during the compilation process.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
Download doxygen's source tarball and put it somewhere (e.g. use c:\\tools )
|
|
Than Ngo |
248e03 |
@@ -214,19 +214,19 @@ you need qhelpgenerator which is part of Qt.
|
|
Than Ngo |
248e03 |
You can download Qt from Qt Software Downloads.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
In order to generate PDF output or use scientific formulas you will also need to
|
|
Than Ngo |
248e03 |
-install LaTeX and
|
|
Than Ngo |
248e03 |
-Ghostscript.
|
|
Than Ngo |
248e03 |
+install LaTeX and
|
|
Than Ngo |
248e03 |
+Ghostscript.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
For \LaTeX a number of distributions exists. Popular ones that should work with
|
|
Than Ngo |
248e03 |
-doxygen are MikTex
|
|
Than Ngo |
248e03 |
+doxygen are MikTex
|
|
Than Ngo |
248e03 |
and proTeXt.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
-Ghostscript can be downloaded
|
|
Than Ngo |
248e03 |
+Ghostscript can be downloaded
|
|
Than Ngo |
248e03 |
from Sourceforge.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
After installing \LaTeX and Ghostscript you'll need to make sure the tools
|
|
Than Ngo |
248e03 |
latex.exe, pdflatex.exe, and gswin32c.exe are present in the search path of a
|
|
Than Ngo |
248e03 |
-command box. Follow these
|
|
Than Ngo |
248e03 |
+command box. Follow these
|
|
Than Ngo |
248e03 |
instructions if you are unsure and run the commands from a command box to verify it works.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
\htmlonly
|
|
Than Ngo |
248e03 |
diff --git a/doc/markdown.doc b/doc/markdown.doc
|
|
Than Ngo |
248e03 |
index 300d7fc7..737df71a 100644
|
|
Than Ngo |
248e03 |
--- a/doc/markdown.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/markdown.doc
|
|
Than Ngo |
248e03 |
@@ -41,9 +41,9 @@ the extensions that doxygen supports.
|
|
Than Ngo |
248e03 |
Finally section \ref markdown_dox discusses some specifics for doxygen's
|
|
Than Ngo |
248e03 |
implementation of the Markdown standard.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
-[markdown]: http://daringfireball.net/projects/markdown
|
|
Than Ngo |
248e03 |
-[mdextra]: http://michelf.com/projects/php-markdown/extra/
|
|
Than Ngo |
248e03 |
-[github]: http://github.github.com/github-flavored-markdown/
|
|
Than Ngo |
248e03 |
+[markdown]: http://daringfireball.net/projects/markdown/
|
|
Than Ngo |
248e03 |
+[mdextra]: https://michelf.ca/projects/php-markdown/extra/
|
|
Than Ngo |
248e03 |
+[github]: https://github.github.com/github-flavored-markdown/
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
\section markdown_std Standard Markdown
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
@@ -303,7 +303,7 @@ Note that using `[TOC]` is the same as using a
|
|
Than Ngo |
248e03 |
\subsection md_tables Tables
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
Of the features defined by "Markdown Extra" is support for
|
|
Than Ngo |
248e03 |
-simple tables:
|
|
Than Ngo |
248e03 |
+simple tables:
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
A table consists of a header line, a separator line, and at least one
|
|
Than Ngo |
248e03 |
row line. Table columns are separated by the pipe (|) character.
|
|
Than Ngo |
248e03 |
@@ -376,7 +376,7 @@ For more complex tables in doxygen please have a look at: \ref tables
|
|
Than Ngo |
248e03 |
\subsection md_fenced Fenced Code Blocks
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
Another feature defined by "Markdown Extra" is support for
|
|
Than Ngo |
248e03 |
-
|
|
Than Ngo |
248e03 |
+
|
|
Than Ngo |
248e03 |
fenced code blocks:
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
A fenced code block does not require indentation, and is
|
|
Than Ngo |
248e03 |
diff --git a/doc/searching.doc b/doc/searching.doc
|
|
Than Ngo |
248e03 |
index dcf858fa..00c61414 100644
|
|
Than Ngo |
248e03 |
--- a/doc/searching.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/searching.doc
|
|
Than Ngo |
248e03 |
@@ -72,7 +72,7 @@ has its own advantages and disadvantages:
|
|
Than Ngo |
248e03 |
searching, meaning that you could use your own indexer and search engine
|
|
Than Ngo |
248e03 |
of choice. To make life easier doxygen ships with an example indexer
|
|
Than Ngo |
248e03 |
(doxyindexer) and search engine (doxysearch.cgi) based on
|
|
Than Ngo |
248e03 |
- the Xapian open source search engine
|
|
Than Ngo |
248e03 |
+ the Xapian open source search engine
|
|
Than Ngo |
248e03 |
library.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
To enable this search method set
|
|
Than Ngo |
248e03 |
@@ -147,7 +147,7 @@ has its own advantages and disadvantages:
|
|
Than Ngo |
248e03 |
\ref cfg_qhp_namespace "QHP_NAMESPACE",
|
|
Than Ngo |
248e03 |
\ref cfg_qhg_location "QHG_LOCATION",
|
|
Than Ngo |
248e03 |
\ref cfg_qhp_virtual_folder "QHP_VIRTUAL_FOLDER".
|
|
Than Ngo |
248e03 |
- See this article
|
|
Than Ngo |
248e03 |
+ See this article
|
|
Than Ngo |
248e03 |
for more info.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
Feature wise the Qt compressed help feature is comparable with the CHM
|
|
Than Ngo |
248e03 |
diff --git a/doc/starting.doc b/doc/starting.doc
|
|
Than Ngo |
248e03 |
index bfb8e8f7..c869867b 100644
|
|
Than Ngo |
248e03 |
--- a/doc/starting.doc
|
|
Than Ngo |
248e03 |
+++ b/doc/starting.doc
|
|
Than Ngo |
248e03 |
@@ -263,7 +263,7 @@ capabilities of the man page format, so some information
|
|
Than Ngo |
248e03 |
\subsection docbook_out DocBook output
|
|
Than Ngo |
248e03 |
\addindex docbook
|
|
Than Ngo |
248e03 |
Doxygen can also generate output in the
|
|
Than Ngo |
248e03 |
-DocBook format. How to process the
|
|
Than Ngo |
248e03 |
+DocBook format. How to process the
|
|
Than Ngo |
248e03 |
DocBook output is beyond the scope of this manual.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
\section step3 Step 3: Documenting the sources
|
|
Than Ngo |
248e03 |
diff --git a/src/config.xml b/src/config.xml
|
|
Than Ngo |
248e03 |
index 0fdf3efc..8bb6addb 100644
|
|
Than Ngo |
248e03 |
--- a/src/config.xml
|
|
Than Ngo |
248e03 |
+++ b/src/config.xml
|
|
Than Ngo |
248e03 |
@@ -215,7 +215,7 @@ Go to the next section or return to the
|
|
Than Ngo |
248e03 |
This tag specifies the encoding used for all characters in the config file that
|
|
Than Ngo |
248e03 |
follow. The default is UTF-8 which is also the encoding used for all text before
|
|
Than Ngo |
248e03 |
the first occurrence of this tag. Doxygen uses \c libiconv (or the iconv built into
|
|
Than Ngo |
248e03 |
- \c libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
|
|
Than Ngo |
248e03 |
+ \c libc) for the transcoding. See https://www.gnu.org/software/libiconv/ for the list of
|
|
Than Ngo |
248e03 |
possible encodings.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
@@ -661,7 +661,7 @@ Go to the next section or return to the
|
|
Than Ngo |
248e03 |
<docs>
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
Set the \c SIP_SUPPORT tag to \c YES if your project consists
|
|
Than Ngo |
248e03 |
- of sip sources only.
|
|
Than Ngo |
248e03 |
+ of sip sources only.
|
|
Than Ngo |
248e03 |
Doxygen will parse them like normal C++ but will assume all classes use public
|
|
Than Ngo |
248e03 |
instead of private inheritance when no explicit protection keyword is present.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
@@ -1172,7 +1172,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
|
|
Than Ngo |
248e03 |
The \c CITE_BIB_FILES tag can be used to specify one or more \c bib files
|
|
Than Ngo |
248e03 |
containing the reference definitions. This must be a list of .bib files. The
|
|
Than Ngo |
248e03 |
.bib extension is automatically appended if omitted. This requires the
|
|
Than Ngo |
248e03 |
- \c bibtex tool to be installed. See also http://en.wikipedia.org/wiki/BibTeX for
|
|
Than Ngo |
248e03 |
+ \c bibtex tool to be installed. See also https://en.wikipedia.org/wiki/BibTeX for
|
|
Than Ngo |
248e03 |
more info. For \f$\mbox{\LaTeX}\f$ the style of the bibliography can be controlled
|
|
Than Ngo |
248e03 |
using \ref cfg_latex_bib_style "LATEX_BIB_STYLE".
|
|
Than Ngo |
248e03 |
To use this feature you need \c bibtex and \c perl available in the search path.
|
|
Than Ngo |
248e03 |
@@ -1285,7 +1285,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
|
|
Than Ngo |
248e03 |
This tag can be used to specify the character encoding of the source files that
|
|
Than Ngo |
248e03 |
doxygen parses. Internally doxygen uses the UTF-8 encoding.
|
|
Than Ngo |
248e03 |
Doxygen uses `libiconv` (or the `iconv` built into `libc`) for the transcoding.
|
|
Than Ngo |
248e03 |
- See the libiconv documentation for
|
|
Than Ngo |
248e03 |
+ See the libiconv documentation for
|
|
Than Ngo |
248e03 |
the list of possible encodings.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
@@ -1585,7 +1585,7 @@ to disable this feature.
|
|
Than Ngo |
248e03 |
If the \c USE_HTAGS tag is set to \c YES then the references to source code
|
|
Than Ngo |
248e03 |
will point to the HTML generated by the \c htags(1) tool instead of doxygen
|
|
Than Ngo |
248e03 |
built-in source browser. The \c htags tool is part of GNU's global source
|
|
Than Ngo |
248e03 |
- tagging system (see http://www.gnu.org/software/global/global.html). You
|
|
Than Ngo |
248e03 |
+ tagging system (see https://www.gnu.org/software/global/global.html). You
|
|
Than Ngo |
248e03 |
will need version 4.8.6 or higher.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
To use it do the following:
|
|
Than Ngo |
248e03 |
@@ -1904,7 +1904,7 @@ hr.footer {
|
|
Than Ngo |
248e03 |
The \c HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
|
|
Than Ngo |
248e03 |
Doxygen will adjust the colors in the style sheet and background images
|
|
Than Ngo |
248e03 |
according to this color. Hue is specified as an angle on a colorwheel,
|
|
Than Ngo |
248e03 |
- see http://en.wikipedia.org/wiki/Hue for more information.
|
|
Than Ngo |
248e03 |
+ see https://en.wikipedia.org/wiki/Hue for more information.
|
|
Than Ngo |
248e03 |
For instance the value 0 represents red, 60 is yellow, 120 is green,
|
|
Than Ngo |
248e03 |
180 is cyan, 240 is blue, 300 purple, and 360 is red again.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
@@ -1981,14 +1981,14 @@ hr.footer {
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
If the \c GENERATE_DOCSET tag is set to \c YES, additional index files
|
|
Than Ngo |
248e03 |
will be generated that can be used as input for
|
|
Than Ngo |
248e03 |
- Apple's Xcode 3
|
|
Than Ngo |
248e03 |
+ Apple's Xcode 3
|
|
Than Ngo |
248e03 |
integrated development environment, introduced with OSX 10.5 (Leopard).
|
|
Than Ngo |
248e03 |
To create a documentation set, doxygen will generate a Makefile in the
|
|
Than Ngo |
248e03 |
HTML output directory. Running \c make will produce the docset in that
|
|
Than Ngo |
248e03 |
directory and running make install will install the docset in
|
|
Than Ngo |
248e03 |
~/Library/Developer/Shared/Documentation/DocSets
|
|
Than Ngo |
248e03 |
so that Xcode will find it at startup. See
|
|
Than Ngo |
248e03 |
- http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for
|
|
Than Ngo |
248e03 |
+ https://developer.apple.com/tools/creatingdocsetswithdoxygen.html for
|
|
Than Ngo |
248e03 |
more information.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
@@ -2133,7 +2133,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
The \c QHP_NAMESPACE tag specifies the namespace to use when generating
|
|
Than Ngo |
248e03 |
Qt Help Project output. For more information please see
|
|
Than Ngo |
248e03 |
- Qt Help Project / Namespace.
|
|
Than Ngo |
248e03 |
+ Qt Help Project / Namespace.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
</option>
|
|
Than Ngo |
248e03 |
@@ -2142,7 +2142,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
The \c QHP_VIRTUAL_FOLDER tag specifies the namespace to use when
|
|
Than Ngo |
248e03 |
generating Qt Help Project output. For more information please see
|
|
Than Ngo |
248e03 |
- Qt Help Project / Virtual Folders.
|
|
Than Ngo |
248e03 |
+ Qt Help Project / Virtual Folders.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
</option>
|
|
Than Ngo |
248e03 |
@@ -2150,7 +2150,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
|
|
Than Ngo |
248e03 |
<docs>
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
If the \c QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom filter to add. For more information please see
|
|
Than Ngo |
248e03 |
- Qt Help Project / Custom Filters.
|
|
Than Ngo |
248e03 |
+ Qt Help Project / Custom Filters.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
</option>
|
|
Than Ngo |
248e03 |
@@ -2159,7 +2159,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
The \c QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the custom filter to add.
|
|
Than Ngo |
248e03 |
For more information please see
|
|
Than Ngo |
248e03 |
- Qt Help Project / Custom Filters.
|
|
Than Ngo |
248e03 |
+ Qt Help Project / Custom Filters.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
</option>
|
|
Than Ngo |
248e03 |
@@ -2167,7 +2167,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
|
|
Than Ngo |
248e03 |
<docs>
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
The \c QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's filter section matches.
|
|
Than Ngo |
248e03 |
- Qt Help Project / Filter Attributes.
|
|
Than Ngo |
248e03 |
+ Qt Help Project / Filter Attributes.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
</option>
|
|
Than Ngo |
248e03 |
@@ -2295,7 +2295,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
|
|
Than Ngo |
248e03 |
<docs>
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
Enable the \c USE_MATHJAX option to render \f$\mbox{\LaTeX}\f$ formulas using MathJax
|
|
Than Ngo |
248e03 |
- (see http://www.mathjax.org) which uses client side Javascript for the
|
|
Than Ngo |
248e03 |
+ (see https://www.mathjax.org) which uses client side Javascript for the
|
|
Than Ngo |
248e03 |
rendering instead of using pre-rendered bitmaps. Use this if you do not
|
|
Than Ngo |
248e03 |
have \f$\mbox{\LaTeX}\f$ installed or if you want to formulas look prettier in the HTML
|
|
Than Ngo |
248e03 |
output. When enabled you may also need to install MathJax separately and
|
|
Than Ngo |
248e03 |
@@ -2327,7 +2327,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
|
|
Than Ngo |
248e03 |
\c MATHJAX_RELPATH should be ../mathjax . The default value points to
|
|
Than Ngo |
248e03 |
the MathJax Content Delivery Network so you can quickly see the result without
|
|
Than Ngo |
248e03 |
installing MathJax. However, it is strongly recommended to install a local
|
|
Than Ngo |
248e03 |
- copy of MathJax from http://www.mathjax.org before deployment.
|
|
Than Ngo |
248e03 |
+ copy of MathJax from https://www.mathjax.org before deployment.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
</option>
|
|
Than Ngo |
248e03 |
@@ -2427,7 +2427,7 @@ See the section \ref extsearch for details.
|
|
Than Ngo |
248e03 |
the search results.
|
|
Than Ngo |
248e03 |
Doxygen ships with an example indexer (\c doxyindexer) and
|
|
Than Ngo |
248e03 |
search engine (doxysearch.cgi ) which are based on the open source search
|
|
Than Ngo |
248e03 |
- engine library Xapian.
|
|
Than Ngo |
248e03 |
+ engine library Xapian.
|
|
Than Ngo |
248e03 |
See the section \ref extsearch for details.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
@@ -2440,7 +2440,7 @@ See the section \ref extsearch for details.
|
|
Than Ngo |
248e03 |
is enabled.
|
|
Than Ngo |
248e03 |
Doxygen ships with an example indexer (\c doxyindexer) and
|
|
Than Ngo |
248e03 |
search engine (doxysearch.cgi ) which are based on the open source search
|
|
Than Ngo |
248e03 |
- engine library Xapian.
|
|
Than Ngo |
248e03 |
+ engine library Xapian.
|
|
Than Ngo |
248e03 |
See the section \ref extsearch for details.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
@@ -2681,7 +2681,7 @@ or
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
The \c LATEX_BIB_STYLE tag can be used to specify the style to use for the
|
|
Than Ngo |
248e03 |
bibliography, e.g. \c plainnat, or \c ieeetr.
|
|
Than Ngo |
248e03 |
- See http://en.wikipedia.org/wiki/BibTeX and \ref cmdcite "\\cite"
|
|
Than Ngo |
248e03 |
+ See https://en.wikipedia.org/wiki/BibTeX and \ref cmdcite "\\cite"
|
|
Than Ngo |
248e03 |
for more info.
|
|
Than Ngo |
248e03 |
]]>
|
|
Than Ngo |
248e03 |
</docs>
|
|
Than Ngo |
248e03 |
@@ -2886,7 +2886,7 @@ front of it.
|
|
Than Ngo |
248e03 |
<docs>
|
|
Than Ngo |
248e03 |
|
|
Than Ngo |
248e03 |
If the \c GENERATE_AUTOGEN_DEF tag is set to \c YES, doxygen will
|
|
Than Ngo |
248e03 |
- generate an AutoGen Definitions (see http://autogen.sf.net) file
|
|
Than Ngo |
248e03 |
+ generate an AutoGen Definitions (see http://autogen.sourceforge.net/) file
|
|
Than Ngo |
248e03 |
that captures the structure of the code including all
|
|
Than Ngo |
248e03 |
documentation. Note that this feature is still experimental
|
|
Than Ngo |
248e03 |
and incomplete at the moment.
|