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 /examples/autolink.cpp | |
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 'examples/autolink.cpp')
-rw-r--r-- | examples/autolink.cpp | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/examples/autolink.cpp b/examples/autolink.cpp index e028f22..71a3c85 100644 --- a/examples/autolink.cpp +++ b/examples/autolink.cpp @@ -1,33 +1,33 @@ /*! \file autolink.cpp Testing automatic link generation. - A link to a member of the Test class: Test::member, + A link to a member of the Autolink_Test class: Autolink_Test::member, More specific links to the each of the overloaded members: - Test::member(int) and Test#member(int,int) + Autolink_Test::member(int) and Autolink_Test#member(int,int) - A link to a protected member variable of Test: Test#var, + A link to a protected member variable of Autolink_Test: Autolink_Test#var, A link to the global enumeration type #GlobEnum. A link to the define #ABS(x). - A link to the destructor of the Test class: Test::~Test, + A link to the destructor of the Autolink_Test class: Autolink_Test::~Autolink_Test, A link to the typedef ::B. - A link to the enumeration type Test::EType + A link to the enumeration type Autolink_Test::EType - A link to some enumeration values Test::Val1 and ::GVal2 + A link to some enumeration values Autolink_Test::Val1 and ::GVal2 */ /*! - Since this documentation block belongs to the class Test no link to - Test is generated. + Since this documentation block belongs to the class Autolink_Test no link to + Autolink_Test is generated. - Two ways to link to a constructor are: #Test and Test(). + Two ways to link to a constructor are: #Autolink_Test and Autolink_Test(). - Links to the destructor are: #~Test and ~Test(). + Links to the destructor are: #~Autolink_Test and ~Autolink_Test(). A link to a member in this class: member(). @@ -46,19 +46,19 @@ A link to the enumeration type #EType. - A link to some enumeration values: \link Test::Val1 Val1 \endlink and ::GVal1. + A link to some enumeration values: \link Autolink_Test::Val1 Val1 \endlink and ::GVal1. And last but not least a link to a file: autolink.cpp. \sa Inside a see also section any word is checked, so EType, - Val1, GVal1, ~Test and member will be replaced by links in HTML. + Val1, GVal1, ~Autolink_Test and member will be replaced by links in HTML. */ -class Test +class Autolink_Test { public: - Test(); //!< constructor - ~Test(); //!< destructor + Autolink_Test(); //!< constructor + ~Autolink_Test(); //!< destructor void member(int); /**< A member function. Details. */ void member(int,int); /**< An overloaded member function. Details */ @@ -73,10 +73,10 @@ class Test }; /*! details. */ -Test::Test() { } +Autolink_Test::Autolink_Test() { } /*! details. */ -Test::~Test() { } +Autolink_Test::~Autolink_Test() { } /*! A global variable. */ int globVar; @@ -92,8 +92,8 @@ enum GlobEnum { */ #define ABS(x) (((x)>0)?(x):-(x)) -typedef Test B; +typedef Autolink_Test B; -/*! \fn typedef Test B +/*! \fn typedef Autolink_Test B * A type definition. */ |