From 3a236fd01dc23d2d979e06d848f61b002cb4e6ee Mon Sep 17 00:00:00 2001 From: albert-github Date: Sun, 6 Sep 2015 11:24:48 +0200 Subject: 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. --- doc/autolink.doc | 4 ++-- doc/commands.doc | 28 ++++++++++++++-------------- doc/diagrams.doc | 10 +++++----- doc/grouping.doc | 4 ++-- examples/afterdoc.cfg | 1 + examples/class.cfg | 1 + examples/define.cfg | 1 + examples/diagrams.cfg | 1 + examples/enum.cfg | 1 + examples/file.cfg | 1 + examples/func.cfg | 1 + examples/structcmd.cfg | 1 + 12 files changed, 31 insertions(+), 23 deletions(-) diff --git a/doc/autolink.doc b/doc/autolink.doc index fe0bdea..b0020b1 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -110,7 +110,7 @@ patterns 3 and 7 in this case. \par Example: - \verbinclude autolink.cpp + \include autolink.cpp \htmlonly Click here 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 here for the corresponding HTML documentation that is generated by Doxygen. diff --git a/doc/commands.doc b/doc/commands.doc index 01d069f..df120a2 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -358,7 +358,7 @@ Structural indicators the \ref cmdheaderfile "\\headerfile" command. \par Example: - \verbinclude class.h + \include class.h \htmlonly Click here 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 here 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 here 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 here 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 here 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 here 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 here 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 here 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 here 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 here 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 here 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 here for the corresponding HTML documentation that is generated by doxygen. diff --git a/doc/diagrams.doc b/doc/diagrams.doc index 7d497bd..2660b8e 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -127,15 +127,15 @@ Here are a couple of header files that together show the various diagrams that doxygen can generate: diagrams_a.h -\verbinclude diagrams_a.h +\include diagrams_a.h diagrams_b.h -\verbinclude diagrams_b.h +\include diagrams_b.h diagrams_c.h -\verbinclude diagrams_c.h +\include diagrams_c.h diagrams_d.h -\verbinclude diagrams_d.h +\include diagrams_d.h diagrams_e.h -\verbinclude diagrams_e.h +\include diagrams_e.h \htmlonly Click here diff --git a/doc/grouping.doc b/doc/grouping.doc index f369998..4357d27 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -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 here @@ -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 here diff --git a/examples/afterdoc.cfg b/examples/afterdoc.cfg index 9ec54fd..0542929 100644 --- a/examples/afterdoc.cfg +++ b/examples/afterdoc.cfg @@ -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 diff --git a/examples/class.cfg b/examples/class.cfg index 515689f..5d75373 100644 --- a/examples/class.cfg +++ b/examples/class.cfg @@ -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 diff --git a/examples/define.cfg b/examples/define.cfg index 491c1eb..61c0f52 100644 --- a/examples/define.cfg +++ b/examples/define.cfg @@ -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 diff --git a/examples/diagrams.cfg b/examples/diagrams.cfg index 19cbbc8..c2e637d 100644 --- a/examples/diagrams.cfg +++ b/examples/diagrams.cfg @@ -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 diff --git a/examples/enum.cfg b/examples/enum.cfg index 74bb651..e5540bd 100644 --- a/examples/enum.cfg +++ b/examples/enum.cfg @@ -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 diff --git a/examples/file.cfg b/examples/file.cfg index 6b20b87..ef67ae6 100644 --- a/examples/file.cfg +++ b/examples/file.cfg @@ -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 diff --git a/examples/func.cfg b/examples/func.cfg index c0feb0f..2f455d9 100644 --- a/examples/func.cfg +++ b/examples/func.cfg @@ -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 diff --git a/examples/structcmd.cfg b/examples/structcmd.cfg index d510d27..f926ddf 100644 --- a/examples/structcmd.cfg +++ b/examples/structcmd.cfg @@ -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 -- cgit v0.12