summaryrefslogtreecommitdiffstats
path: root/doc/Doxyfile
Commit message (Collapse)AuthorAgeFilesLines
* Present all warnings of first documentation sub-task when it failsalbert-github2020-12-041-1/+1
| | | | | This is a follow-up on pull request #8199 (Have build of doxygen documentation fail on warnings.) and #8197 (issue #8023 Add option to exit with non-zero exit code on warnings even if WARN_AS_ERROR is OFF). These were 2 independent situation, but as with #8197 incor[porated into doxygen it is no possible to extend #8199 to fail but at present all warnings of the first (sub-)task that fails.
* Have build of doxygen documentation fail on warnings.albert-github2020-11-241-0/+1
| | | | | Currently when running doxygen to create its documentation no error is given when a warning is generated, so the warning might go unnoticed. By setting `WARN_AS_ERROR = YES` the generation will stop and when build on CI systems a build also fails
* Update of doxywizard documetationalbert-github2020-11-091-1/+2
| | | | Bringing the doxywizard documentation up to date with the current version.
* Updated the logo in the manualDimitri van Heesch2020-08-081-2/+1
|
* Generating doxygen's documentation in CHM formatalbert-github2019-08-111-0/+2
| | | | | | | | | | | | | | | Until now the chm format of the doxygen documentation was generated by a separate script, this is now integrated in the CMake procedure. - option -Dbuild_doc_chm to enable the possibility to generate the CHM documentation (only works for windows) - procedure is as follows - generate the base documentation for the CHM output - copy the documentation of the examples to the tree with the base CHM output (cannot use it from its default place due to the fact that in the next face the first page of the CHM file will be wrong - add the html, png, css and gif files of the examples to the so called hhp file (has to happen during runtime, hence a small python script, created inline so there is no extra file in the source tree) - create the resulting doxygen_manual.chm Some improvements during the process - the html files of the examples are added so that the full documentation of the examples is accessible and not just the top pages of the examples - keep the index terms of base chm file (mostly the commands and configuration parameters) - see to it that the doxygen logo is copied by doxygen and not by means of cmake
* Bug 783759 - PERL_PATH config option: when is this needed? Still used?albert-github2019-05-071-1/+0
| | | | As, more or less, mentioned in the bug report: in version 1.7.6.1 the PERL_PATH is still in use (instdox.cpp) but in version 1.8.0 it is not used anymore, so the parameter has been set to obsolete now.
* Improved robustness of the emoji featureDimitri van Heesch2018-12-231-0/+1
| | | | | | | | Changes: - Use of `@emoji name` instead of `:name:` - Support only GitHub emojis (i.e. without spaces or special characters in the name) - Provided script to download images for LaTeX support. - XML output now has <emoji> tag with name an unicode sequence.
* issue_6517: Emoji supportalbert-github2018-10-011-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Added issue support for the different output types. - Sources of the emoji - based on the Unicode definition v11.0: - https://unicode.org/emoji/charts/full-emoji-list.html - http://www.unicode.org/emoji/charts/full-emoji-modifiers.html - github definition list: - https://api.github.com/emojis - Input of emoji: :<test>: with the restriction that direct after the opening colon and direct before the closing colon no space is allowed - doctokinizer.l, adding detection of emoji and new command `\:` - doktokinizer.h, adding "word" type TK_EMOJI - docparser.* handling of new "word" type TK_EMOJI (analogous to HTML Entities), handling of new command `\:` - cmdmapper,cpp, cmdmapper.h, adding new command `\:` - htmlentity.cpp, adding new definition required for new command `\:` - Emoji - emoji.cpp, emoji.h, class for handling emoji analogous to HTML Entities, including small directions on how to update the code when a new emoji is defined. Not everything is converted to lowercase for comparison and accents are removed. - doxygen.cpp possibility to create list of supported emoji - handling emoji for output types (analogous to HTML Entities), see documentation for different output types - docparser.h, *docvisitor.* - rtfdocvisitor.* converting output to UTF-16 (based on http://scruss.com/blog/2017/03/12/in-the-unlikely-event-you-need-to-represent-emoji-in-rtf-using-perl/) - latexdocvisitor.*, handling arguments for emoji in output (see also latexgen.cpp for meaning of the arguments of doxygenemoji). - latexgen.cpp, adding new latex command for doxygen (doxygenemoji) and prevent too many open file (code before documentclass) - config.xml, definition of `LATEX_EMOJI_DIRECTORY` with path to images required for LaTeX output - Documentation: - emojisup.doc, user description - commands.doc, description of new command `\:` - index.doc, reference to emoji chapter - xmlcmds.doc, adjust reference to next chapter as a new chapter is added - Doxyfile*, adding emoji chapter Build system - CMakeLists.txt adding new files
* Add examples to LaTeX / PDF doxygen manualalbert-github2015-09-051-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add the examples a shown in the HTML / CHM documentation also to the LaTeX / PDF documentation. - doc/*.doc added latexonly part referencing the example in the appendix - doc/Doxyfile silence the generation of the manual - doc/doxygen_manual.tex add the examples as appendices to the manual, by means of the subinputfrom command the parts included by refman_doc are taken from the specified directory - examples/*.cfg adjusted configuration files ("Doxyfile") to generate LaTeX output - examples/*.h and examples/*.cpp make names unique so no conflicts occur when adding all the examples - examples/CMakeLists.txt add generation of the file to be included (see strip_example.py), adjust dependencies and add the refman_doc.tex as output target - examples/input_test.cpp file added (adjusted copy of example_test.cpp) to overcome name clashes (example_test.cpp would have been included twice) - examples/strip_example.py we are only interested in the documentation files as included in the different examples, so we get those commands. The preamble will be handled by the doxygen_manual.tex and we have already an index in the doxygen_manual.tex so we don't need a separate one from each example. The module / diagram documentation is dependent on the presence of 'dot', this is reflected in the docblocks.doc, CMakeLists.txt and doxygen_manual.tex
* Added documentation for creating tablesDimitri van Heesch2015-08-261-1/+1
|
* Using tabu package for LaTeX tablesDimitri van Heesch2015-07-121-0/+1
|
* Fixes for running tests and generating docs with cmakeDimitri van Heesch2015-06-031-0/+1
|
* Consistency of usage of the word LaTeX in the documentationalbert-github2014-04-131-0/+2
| | | | | | The word LaTeX was used as just the word and on other places as \f$\mbox{\LaTeX}\f$ This has been made more consistent by means of the definition of the Alia \LaTeX (similar for \TeX) Some names of executables etc. were not set in a 'code' font.
* Release-1.8.3.1-20130512Dimitri van Heesch2013-05-121-1/+1
|
* Release-1.8.3.1Dimitri van Heesch2013-01-201-1/+1
|
* Release-1.8.3Dimitri van Heesch2012-12-261-1/+1
|
* Release-1.8.1.2Dimitri van Heesch2012-07-121-1/+1
|
* Release-1.7.6.1-20120122Dimitri van Heesch2012-01-221-2/+5
|
* Release-1.7.6.1-20120110Dimitri van Heesch2012-01-101-2/+1
|
* Release-1.7.6.1-20111226Dimitri van Heesch2011-12-261-1/+1
|
* Release-1.7.2-20101106Dimitri van Heesch2010-11-061-1/+1
|
* Release-1.7.0Dimitri van Heesch2010-06-151-1/+1
|
* Release-1.6.1-20091222Dimitri van Heesch2009-12-221-1/+2
|
* Release-1.5.6-20080819Dimitri van Heesch2008-08-191-1/+1
|
* Release-1.5.2-20070610Dimitri van Heesch2007-06-101-1/+1
|
* Release-1.4.3-20050615Dimitri van Heesch2005-06-151-1/+1
|
* Release-1.3.8-20040803Dimitri van Heesch2004-08-031-3/+2
|
* Release-1.3.3-20030915Dimitri van Heesch2003-09-151-0/+1
|
* Release-1.3.3-20030824Dimitri van Heesch2003-08-241-7/+1
|
* Release-1.3.3Dimitri van Heesch2003-07-251-0/+1
|
* Release-1.2.18-20021030Dimitri van Heesch2002-10-301-1/+2
|
* Release-1.2.16Dimitri van Heesch2002-05-201-0/+1
|
* Release-1.2.10-20010909Dimitri van Heesch2001-09-091-1/+1
|
* Release-1.2.9Dimitri van Heesch2001-08-011-1/+1
|
* Release-1.2.1Dimitri van Heesch2000-08-131-1/+1
|
* Release-1.2.0Dimitri van Heesch2000-07-231-2/+6
|
* Release-1.1.5-20000716Dimitri van Heesch2000-07-161-5/+6
|
* Release-1.1.5_20000709Dimitri van Heesch2000-07-091-0/+1
|
* Release 2000-04-03Dimitri van Heesch2000-04-031-1/+2
|
* Release-1.1.1-20000326Dimitri van Heesch2000-03-261-1/+1
|
* mods for doxygen-0.49-991106Dimitri van Heesch1999-12-151-27/+28
|
* mods for doxygen-0.49-991003Dimitri van Heesch1999-12-151-1/+15
|
* mods for doxygen-0.49-990901Dimitri van Heesch1999-12-151-0/+1
|
* mods for doxygen-0.49-990728Dimitri van Heesch1999-12-151-2/+2
|
* initial versionDimitri van Heesch1999-12-151-0/+30
generated by cgit v0.12 at 2024-11-05 06:51:07 (GMT)