| Commit message (Collapse) | Author | Age | Files | Lines |
| |
|
|
|
|
| |
Added a general warning about the `/****//**` type of comment
|
| |
|
|
|
|
|
|
| |
improperly
A small warning about the usage of "Putting documentation after members" in case of a define.
|
|
|
|
| |
Update of documentation
|
|\
| |
| | |
Using Python docstrings
|
| |
| |
| |
| |
| | |
- making documentation a bit clearer
- add configuration setting to have docstrings not as preformatted text but as normal documentation (default remains preformatted).
|
|/
|
|
| |
very popular)
|
|
|
|
| |
Corrected spelling
|
| |
|
|
|
|
| |
Added some documentation
|
| |
|
| |
|
|
|
|
|
|
|
|
|
| |
The doxygen manual is not XHTML compliant.
In this, first, fix :
- fixes the problems in the doc files (note that docblocks has a small extra problem, pull request for this is #6660)
- determine output directory for HTML based on the doxyfile (for images).
Note: Remaining problems with examples and old change log files (version 1.5 and earlier)
|
|
|
|
|
| |
The current spelling (also for the older versions) is Javadoc.
Changed on all possible documentation visible places (external and internal).
|
|
|
|
| |
Running a link checker revealed a number of not existing / redirected addresses, these have been corrected.
|
|
|
|
|
|
|
|
| |
currently the \tableofcontents command is only supported for HTML.
In this patch:
- enable in page table of contents for LaTeX: \tableofcontents['{'[option][,option]*'}']
where option can be 'HTML, and 'LaTeX'
(side effect: possibility to have options with, nearly, all commands.)
|
| |
|
|
|
|
|
| |
The W3C link checker reported a number of problems regarding non reachable links and permanent redirects.
Most of these problems have been fixed with this patch
|
| |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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
|
|
|
|
|
|
| |
- syntax correction
- cross reference between HTML table and Markdown table
- removed reference through "here" (problematic in printed documentation, one does not know where to go).
|
| |
|
| |
|
| |
|
|
|
|
| |
Correction in documentation based on comment by dnm on June 19 2014
|
| |
|
|
|
|
|
| |
The recognition of the type (free or fixed) of Fortran code is not reliable possible. A well known possibility as used with compilers as well is to specify the type of code by means of the extension.
With EXTENSION_MAPPING it is possible to select the type of Fortran code, when not explicitly set doxygen tries to guess the type of Fortran code.
|
| |
|
|
|
|
| |
Corrected some spelling errors and added / correceted some references
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|