diff options
author | albert-github <albert.tests@gmail.com> | 2018-09-15 09:40:02 (GMT) |
---|---|---|
committer | albert-github <albert.tests@gmail.com> | 2018-09-15 09:40:02 (GMT) |
commit | ed1fb80b55bab16443b211ebeb1cd45bb630b08b (patch) | |
tree | 9b5606ed13d96aa8e64f744205cda30e21f6e2fb /doc | |
parent | aca45fd514cadc56ac277bd54f49604708ebbb5d (diff) | |
download | Doxygen-ed1fb80b55bab16443b211ebeb1cd45bb630b08b.zip Doxygen-ed1fb80b55bab16443b211ebeb1cd45bb630b08b.tar.gz Doxygen-ed1fb80b55bab16443b211ebeb1cd45bb630b08b.tar.bz2 |
Difference between standard and used Doxyfile
Writes a the differences between the current configuration and the template configuration.
Useful when communicating e.g. in forums.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/arch.doc | 16 | ||||
-rw-r--r-- | doc/doxygen.1 | 4 |
2 files changed, 19 insertions, 1 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/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. |