summaryrefslogtreecommitdiffstats
path: root/examples/include.cpp
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/include.cpp
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/include.cpp')
-rw-r--r--examples/include.cpp8
1 files changed, 4 insertions, 4 deletions
diff --git a/examples/include.cpp b/examples/include.cpp
index 674ad13..ba8c054 100644
--- a/examples/include.cpp
+++ b/examples/include.cpp
@@ -1,7 +1,7 @@
/*! A test class. */
-class Test
+class Include_Test
{
public:
/// a member function
@@ -9,12 +9,12 @@ class Test
};
/*! \page example
- * \dontinclude example_test.cpp
+ * \dontinclude include_test.cpp
* Our main function starts like this:
* \skip main
* \until {
- * First we create an object \c t of the Test class.
- * \skipline Test
+ * First we create an object \c t of the Include_Test class.
+ * \skipline Include_Test
* Then we call the example member function
* \line example
* After that our little test routine ends.