Merge branch 'master' into feature/bug_tests_extensions

4 files changed, 34 insertions, 6 deletions

diff --git a/doc/arch.doc b/doc/arch.doc
index ed9d579..bd51a1b 100644
--- a/doc/arch.doc
+++ b/doc/arch.doc
@@ -248,7 +248,21 @@ Note that by running doxygen with `-d lex` you get information about which
 <h3>Testing</h3>
 
 Doxygen has a small set of tests available to test, some, code integrity.
-The tests can be run by means of the command `make tests`. When only one or a few tests are required one can set the variable \c TEST_FLAGS when running the test e.g. `make TEST_FLAGS="--id 5" tests` or for multiple tests `make TEST_FLAGS="--id 5 --id 7" tests`.
+The tests can be run by means of the command `make tests`. When only one or a
+few tests are required one can set the variable \c TEST_FLAGS when running the
+test e.g. `make TEST_FLAGS="--id 5" tests` or for multiple tests
+`make TEST_FLAGS="--id 5 --id 7" tests`. For a full set of possibilities give the
+command `make TEST_FLAGS="--help" tests`. It is also possible to specify the
+`TEST_FLAGS` as an environment variable (works also for testing through Visual
+Studio projects), e.g. `setenv TEST_FLAGS "--id 5 --id 7"` and `make tests`.
+
+<h3>Doxyfile differences</h3>
+
+In case one has to communicate through e.g. a forum the configuration settings that 
+are different from the standard doxygen configuration file settings one can run the
+doxygen command: with the `-x` option and the name of the configuration file (default
+is `Doxyfile`). The output will be a list of the not default settings (in `Doxyfile`
+format).
 
 \htmlonly
 Return to the <a href="index.html">index</a>.
diff --git a/doc/custcmd.doc b/doc/custcmd.doc
index acc0224..02805da 100644
--- a/doc/custcmd.doc
+++ b/doc/custcmd.doc
@@ -44,6 +44,11 @@ Note that you can put `\n`'s in the value part of an alias to insert newlines
 (in the resulting output). You can put `^^` in the value part of an alias to
 insert a newline as if a physical newline was in the original file.
 
+Note when you need a literal `{` or `}` or `,` in the value part of an alias you have to
+escape them by means of a backslash (`\`), this can lead to conflicts with the
+commands \c \\{ and \c \\} for these it is advised to use the version \c @@{ and \c @@} or
+use a double escape (\c \\\\{ and \c \\\\})
+
 Also note that you can redefine existing special commands if you wish.
 
 Some commands, such as \ref cmdxrefitem "\\xrefitem" are designed to be used in
diff --git a/doc/doxygen.1 b/doc/doxygen.1
index 5ac287e..a9c6b38 100644
--- a/doc/doxygen.1
+++ b/doc/doxygen.1
@@ -41,6 +41,10 @@ LaTeX: doxygen \fB\-w\fR latex headerFile footerFile styleSheetFile [configFile]
 .TP
 RTF:
 doxygen \fB\-e\fR rtf extensionsFile
+.TP
+7) Use doxygen to compare the used configuration file with the template configuration file
+.TP
+doxygen \fB\-x\fR [configFile]
 .PP
 If \fB\-s\fR is specified the comments in the config file will be omitted.
 If configName is omitted `Doxyfile' will be used as a default.
diff --git a/doc/install.doc b/doc/install.doc
index 497a0c0..7df0dee 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -36,6 +36,7 @@ following to build the executable:
     \addindex make
     \addindex strip
     \addindex python
+<li>You need \c python (version 2.6 or higher, see https://www.python.org).
 <li>In order to generate a \c Makefile for your platform, you need 
     <a href="https://cmake.org/">cmake</a> version 2.8.12 or later.
     \addindex cmake
@@ -48,7 +49,7 @@ tools should be installed.
 <li>Qt Software's GUI toolkit 
     <a href="http://qt-project.org/">Qt</A>
     \addindex Qt
-    version 4.3 or higher (but currently, Qt 5.x is not yet supported).
+    version 4.3 or higher (including Qt 5).
     This is needed to build the GUI front-end doxywizard. 
 <li>A \LaTeX distribution: for instance
     <a href="http://www.tug.org/interest.html#free">TeX Live</a>
@@ -151,6 +152,7 @@ standard installation procedure that is required for these packages.
 
 From version 1.8.10 onwards, build files need to be generated by cmake.
 cmake can be downloaded from https://cmake.org/download/
+\addindex cmake
 
 At the moment only the express version of Visual Studio 2013 is tested,
 but other version might also work.
@@ -160,9 +162,12 @@ Alternatively, you can compile doxygen
 <a href="https://en.wikipedia.org/wiki/Cygwin">Cygwin</a>
 or <a href="http://www.mingw.org/">MinGW</a>.
 
+\addindex flex
+\addindex bison
 The next step is to install modern versions of \c bison and \c flex
 (see https://sourceforge.net/projects/winflexbison/. After installation and adding them to
 your `path` rename `win_flex.exe` to `flex.exe` and `win_bison.exe` to `bison.exe`)
+\addindex python
 Furthermore you have to install \c python (version 2.6 or higher, see https://www.python.org).
 These packages are needed during the compilation process.
 
@@ -174,7 +179,7 @@ cd c:\tools
 tar zxvf doxygen-x.y.z.src.tar.gz
 \endverbatim
 to unpack the sources (you can obtain \c tar from e.g. http://gnuwin32.sourceforge.net/packages.html).
-Alternatively you can use an unpack program, like 7-Zip (see http://www.7-zip.org)
+Alternatively you can use an unpack program, like 7-Zip (see https://www.7-zip.org/)
 or use the build in unpack feature of modern Windows systems).
 
 Now your environment is setup to generate the required project files for \c doxygen.
@@ -186,8 +191,8 @@ cd build
 cmake -G "Visual Studio 12 2013" ..
 \endverbatim
 
-Note that compiling Doxywizard currently requires Qt version 4
-(see http://qt-project.org/).
+Note that compiling Doxywizard requires Qt 4.3 or newer
+(see https://www.qt.io/developers/).
 
 Also read the next section for additional tools you may need to install to run
 doxygen with certain features enabled.
@@ -219,7 +224,7 @@ install <a href="https://en.wikipedia.org/wiki/LaTeX">LaTeX</a> and
 
 For \LaTeX a number of distributions exists. Popular ones that should work with
 doxygen are <a href="https://miktex.org/">MikTex</a> 
-and <a href="http://www.tug.org/protext/">proTeXt</a>.
+and <a href="https://www.tug.org/protext/">proTeXt</a>.
 
 Ghostscript can be <a href="https://sourceforge.net/projects/ghostscript/">downloaded</a> 
 from Sourceforge.