| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| | |
|
| |
|
|
|
| |
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
|
| | |
|
| | |
|
| | |
|
| |\
| |
| | |
Documentation small corrections
|
| | | |
|
| | | |
|
| | |
| |
| |
| | |
in PDF output Data Fields
|
| | | |
|
| | | |
|
| | | |
|
| | |
| |
| |
| |
| |
| |
| |
| |
| | |
This patch makes the handling of the \snippet and other commands consistent between the different languages (no line numbers anymore with python) and also introduces analogous to \includelineno the command \snippetlineno.
Some non relevant changes:
- *code.l Calculation of the end line was incorrect, in case of a snippet the end line was the number of lines of the snippet and not reltive to the start line.
- *code.l made consistent over the different laguages, enabling exBlock and inlineFragment
- testing/indexpage.xml in test 14 the \snippet command was used with python and giving line numbers, linenumbers are now gone (consistency)
|
| | |
| |
| |
| |
| | |
Purpose to have the possibility to have repeating texts not repeated in the comments.
The commands include and snippet introduce code blocks whilst the commands includedoc and snippetdoc inclode the text as is and it will be parsed by doxygen.
|
| | |
| |
| |
| | |
Added documentation for pull request #495
|
| | | |
|
| | | |
|
| | | |
|
| | | |
|
| | | |
|
| | |
| |
| |
| |
| | |
- patch should only be applied to images.
- added doxyfigcaption to manual.sty for completeness, when in future a table with an image and caption might appear in the documentation.
|
| | |
| |
| |
| |
| |
| | |
In the documentation generated by doxygen the table of contents does not start with page number i but with iii, by setting the pagenumbering}{roman} after the clearemptydoublepage titlepage this is corrected. In the beginning of the documentation we set the page numbering to "alph" so it won't interfere with the numbers in the table of contents and the real documentation.
For the doxygen manual similar reasoning is true, furthermore the table of contents was on the left side page (when printed double sided), yhis is corrected as well.
|
| | | |
|
| | | |
|
| |/ |
|
| | |
|
| | |
|
| | |
|
| |
|
|
|
|
| |
As both declarations should only differ by cv-qualifiers.
Signed-off-by: Thomas Braun <thomas.braun@byte-physics.de>
|
| |
|
|
|
|
|
|
| |
- doc/*.doc
use include instead of verbinclude to make use of the code coloring in the examples
- examples/*.cfg
some examples automatically display the code from the include file (*.h), for the examples it is better to show the comment as well.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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).
|
| | |
|
| | |
|
| | |
|
| |\
| |
| | |
doc: put man pages under share/man/man1
|
| | |
| |
| |
| |
| |
| |
| |
| |
| | |
I found this on the Linux From Scratch page:
sed -i 's:man/man1:share/&:' ../doc/CMakeLists.txt
With this, the man pages are installed under ${PREFIX}/share/man/man1
http://www.linuxfromscratch.org/blfs/view/svn/general/doxygen.html
|
| |\ \ |
|
| | | | |
|
| |/ /
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
* use configure_files to avoid different $ semantics when COMMAND lines
are expanded in build files. ($$var vs. \$var)
* nmake/gmake no longer needed by cmake, when building doc.
* explicitly copy doc files into build directory to make it clear what
files each build stage uses.
Documentation can be built with:
mkdir build/ && cd $_
cmake -Dbuild_doc=1 .. # add -G"NMake Makefiles" for nmake
make docs # this builds doxygen first
v3: replace file(COPY) with proper generated file tagging.
v2: Remove option to build documentation independently from doxygen.
tested on linux(gmake) and windows(nmake) [thanks albert]
|
| | |
| |
| |
| | |
12.04
|
| | | |
|
| |\ \ |
|
| | |/ |
|
| |/ |
|
| | |
|
| | |
|
| |
|
|
|
|
| |
- made copying doc and example files a target
- fixed bug using temparary in the wizard.
- Added faq question about extension mapping
|
| | |
|
