diff options
author | albert-github <albert.tests@gmail.com> | 2015-09-05 16:42:15 (GMT) |
---|---|---|
committer | albert-github <albert.tests@gmail.com> | 2015-09-05 16:42:15 (GMT) |
commit | 5e11f885eea694c2ecfeae6ff5774b66eea312e4 (patch) | |
tree | 42a6656eb37327c1d76c6a9428dbdf2101761587 /doc/grouping.doc | |
parent | 5aa4ade86499ba615da48875a9e7292ddd22c22f (diff) | |
download | Doxygen-5e11f885eea694c2ecfeae6ff5774b66eea312e4.zip Doxygen-5e11f885eea694c2ecfeae6ff5774b66eea312e4.tar.gz Doxygen-5e11f885eea694c2ecfeae6ff5774b66eea312e4.tar.bz2 |
Add examples to LaTeX / PDF doxygen manual
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
Diffstat (limited to 'doc/grouping.doc')
-rw-r--r-- | doc/grouping.doc | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/grouping.doc b/doc/grouping.doc index a6fdf43..f369998 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -141,6 +141,10 @@ in .c files without having to duplicate the hierarchy exactly. Click <a href="examples/group/html/modules.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly +\latexonly +See \hyperlink{modules_example}{Modules example} +for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. +\endlatexonly \section memgroup Member Groups @@ -194,6 +198,10 @@ documentation of the class. Click <a href="examples/memgrp/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly +\latexonly +See \hyperlink{memgrp_example}{Member Groups example} +for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. +\endlatexonly Here Group1 is displayed as a subsection of the "Public Members". And Group2 is a separate section because it contains members with |