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

1 files changed, 6 insertions, 6 deletions

diff --git a/examples/overload.cpp b/examples/overload.cpp
index 02bcced..7aeb1cb 100644
--- a/examples/overload.cpp
+++ b/examples/overload.cpp
@@ -1,25 +1,25 @@
-class Test 
+class Overload_Test 
 {
   public:
     void drawRect(int,int,int,int);
     void drawRect(const Rect &r);
 };
 
-void Test::drawRect(int x,int y,int w,int h) {}
-void Test::drawRect(const Rect &r) {}
+void Overload_Test::drawRect(int x,int y,int w,int h) {}
+void Overload_Test::drawRect(const Rect &r) {}
 
-/*! \class Test
+/*! \class Overload_Test
  *  \brief A short description.
  *   
  *  More text.
  */
 
-/*! \fn void Test::drawRect(int x,int y,int w,int h)
+/*! \fn void Overload_Test::drawRect(int x,int y,int w,int h)
  * This command draws a rectangle with a left upper corner at ( \a x , \a y ),
  * width \a w and height \a h. 
  */
 
 /*!
- * \overload void Test::drawRect(const Rect &r)
+ * \overload void Overload_Test::drawRect(const Rect &r)
  */