summaryrefslogtreecommitdiffstats
path: root/examples/example.cfg
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2015-09-05 16:42:15 (GMT)
committeralbert-github <albert.tests@gmail.com>2015-09-05 16:42:15 (GMT)
commit5e11f885eea694c2ecfeae6ff5774b66eea312e4 (patch)
tree42a6656eb37327c1d76c6a9428dbdf2101761587 /examples/example.cfg
parent5aa4ade86499ba615da48875a9e7292ddd22c22f (diff)
downloadDoxygen-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 'examples/example.cfg')
-rw-r--r--examples/example.cfg4
1 files changed, 3 insertions, 1 deletions
diff --git a/examples/example.cfg b/examples/example.cfg
index f57e4ba..c55c6b9 100644
--- a/examples/example.cfg
+++ b/examples/example.cfg
@@ -1,7 +1,7 @@
PROJECT_NAME = "Example Command"
OUTPUT_DIRECTORY = ../html/examples/example
#GENERATE_TAGFILE = example.tag
-GENERATE_LATEX = NO
+GENERATE_LATEX = YES
GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
@@ -10,3 +10,5 @@ EXAMPLE_PATH = example_test.cpp
QUIET = YES
JAVADOC_AUTOBRIEF = YES
SEARCHENGINE = NO
+COMPACT_LATEX = YES
+LATEX_HIDE_INDICES = YES