Permalink
Browse files

Add examples to LaTeX / PDF doxygen manual

- doc/*.doc
  use include instead of verbinclude to make use of the code coloring in the examples

- examples/*.cfg
  some examples automatically display the code from the include file (*.h), for the examples it is better to show the comment as well.
  • Loading branch information...
albert-github committed Sep 6, 2015
1 parent 5e11f88 commit 3a236fd01dc23d2d979e06d848f61b002cb4e6ee
@@ -110,7 +110,7 @@
patterns 3 and 7 in this case.
\par Example:
\verbinclude autolink.cpp
\include autolink.cpp
\htmlonly
Click <a href="examples/autolink/html/index.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
@@ -130,7 +130,7 @@ typedef struct StructName TypeName
when either StructName itself or TypeName is encountered.
\par Example:
\verbinclude restypedef.cpp
\include restypedef.cpp
\htmlonly
Click <a href="examples/restypedef/html/restypedef_8cpp.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
@@ -358,7 +358,7 @@ Structural indicators
the \ref cmdheaderfile "\\headerfile" command.
\par Example:
\verbinclude class.h
\include class.h
\htmlonly
Click <a href="examples/class/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -376,7 +376,7 @@ Structural indicators
\c \#define macro.
\par Example:
\verbinclude define.h
\include define.h
\htmlonly
Click <a href="examples/define/html/define_8h.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -429,7 +429,7 @@ Structural indicators
of an anonymous enum can.
\par Example:
\verbinclude enum.h
\include enum.h
\htmlonly
Click <a href="examples/enum/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -462,9 +462,9 @@ Structural indicators
the \ref cmdinclude "\\include" command can be used.
\par Example:
\verbinclude example.cpp
\include example.cpp
Where the example file \c example_test.cpp looks as follows:
\verbinclude example_test.cpp
\include example_test.cpp
\htmlonly
Click <a href="examples/example/html/examples.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -522,7 +522,7 @@ Structural indicators
only be included in the output if the file they are in is documented as well.
\par Example:
\verbinclude file.h
\include file.h
\htmlonly
Click <a href="examples/file/html/file_8h.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -560,7 +560,7 @@ Structural indicators
information and thus to errors.
\par Example:
\verbinclude func.h
\include func.h
\htmlonly
Click <a href="examples/func/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -817,7 +817,7 @@ Structural indicators
\par Note 2:
The \c \\overload command does not work inside a one-line comment.
\par Example:
\verbinclude examples/overload.cpp
\include overload.cpp
\htmlonly
Click <a href="examples/overload/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -845,7 +845,7 @@ Structural indicators
starts a new section in the chapter 'Page documentation'.
\par Example:
\verbinclude page.doc
\include page.doc
\htmlonly
Click <a href="examples/page/html/pages.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -1005,7 +1005,7 @@ Structural indicators
only works for functions.
\par Example:
\verbinclude relates.cpp
\include relates.cpp
\htmlonly
Click <a href="examples/relates/html/class_string.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -1160,7 +1160,7 @@ Section indicators
sectioning command is encountered.
\par Example:
\verbinclude author.cpp
\include author.cpp
\htmlonly
Click <a href="examples/author/html/class_some_nice_class.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -1507,7 +1507,7 @@ ALIASES = "english=\if english" \
sectioning command is encountered.
\par Example:
\verbinclude par.cpp
\include par.cpp
\htmlonly
Click <a href="examples/par/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -2115,9 +2115,9 @@ Commands for displaying examples
\c \\dontinclude command sets the pointer to the first line of the example.
\par Example:
\verbinclude include.cpp
\include include.cpp
Where the example file \c example_test.cpp looks as follows:
\verbinclude example_test.cpp
\include example_test.cpp
\htmlonly
Click <a href="examples/include/html/example.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -127,15 +127,15 @@ Here are a couple of header files that together show the various diagrams
that doxygen can generate:
<code>diagrams_a.h</code>
\verbinclude diagrams_a.h
\include diagrams_a.h
<code>diagrams_b.h</code>
\verbinclude diagrams_b.h
\include diagrams_b.h
<code>diagrams_c.h</code>
\verbinclude diagrams_c.h
\include diagrams_c.h
<code>diagrams_d.h</code>
\verbinclude diagrams_d.h
\include diagrams_d.h
<code>diagrams_e.h</code>
\verbinclude diagrams_e.h
\include diagrams_e.h
\htmlonly
Click <a href="examples/diagrams/html/index.html">here</a>
@@ -135,7 +135,7 @@ files to define the hierarchy and \ref cmdweakgroup "\\weakgroup"
in .c files without having to duplicate the hierarchy exactly.
\par Example:
\verbinclude group.cpp
\include group.cpp
\htmlonly
Click <a href="examples/group/html/modules.html">here</a>
@@ -192,7 +192,7 @@ you should put a \ref cmdnosubgrouping "\\nosubgrouping" command inside the
documentation of the class.
\par Example:
\verbinclude memgrp.cpp
\include memgrp.cpp
\htmlonly
Click <a href="examples/memgrp/html/class_test.html">here</a>
@@ -5,6 +5,7 @@ GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = afterdoc.h
STRIP_CODE_COMMENTS = NO
QUIET = YES
JAVADOC_AUTOBRIEF = YES
SEARCHENGINE = NO
@@ -5,6 +5,7 @@ GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = class.h
STRIP_CODE_COMMENTS = NO
QUIET = YES
JAVADOC_AUTOBRIEF = YES
SEARCHENGINE = NO
@@ -5,6 +5,7 @@ GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = define.h
STRIP_CODE_COMMENTS = NO
ENABLE_PREPROCESSING = YES
QUIET = YES
JAVADOC_AUTOBRIEF = YES
@@ -8,6 +8,7 @@ GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
ENABLE_PREPROCESSING = YES
INPUT = .
STRIP_CODE_COMMENTS = NO
FILE_PATTERNS = diagrams_*.h
QUIET = YES
JAVADOC_AUTOBRIEF = YES
@@ -5,6 +5,7 @@ GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = enum.h
STRIP_CODE_COMMENTS = NO
QUIET = YES
JAVADOC_AUTOBRIEF = YES
SEARCHENGINE = NO
@@ -5,6 +5,7 @@ GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = file.h
STRIP_CODE_COMMENTS = NO
QUIET = YES
JAVADOC_AUTOBRIEF = YES
SEARCHENGINE = NO
@@ -5,6 +5,7 @@ GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = func.h
STRIP_CODE_COMMENTS = NO
QUIET = YES
JAVADOC_AUTOBRIEF = YES
SEARCHENGINE = NO
@@ -5,6 +5,7 @@ GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = structcmd.h
STRIP_CODE_COMMENTS = NO
QUIET = YES
JAVADOC_AUTOBRIEF = YES
SEARCHENGINE = NO

0 comments on commit 3a236fd

Please sign in to comment.