pdf to epub c# : Convert word to pdf with bookmarks control Library platform web page asp.net html web browser doxygen6-part1713

20.1 Format
58
COLLABORATION
GRAPH
20.17
COLS
IN
ALPHA
INDEX
20.7
COMPACT
LATEX
20.9
COMPACT
RTF
20.10
CPP
CLI
SUPPORT
20.2
CREATE
SUBDIRS
20.2
DETAILS
AT
TOP
20.2
DIRECTORY
GRAPH
20.17
DISABLE
INDEX
20.8
DISTRIBUTE
GROUP
DOC
20.2
DOT
GRAPH
MAX
NODES
20.17
DOT
IMAGE
FORMAT
20.17
DOT
MULTI
TARGETS
20.17
DOT
PATH
20.17
DOT
TRANSPARENT
20.17
DOTFILE
DIRS
20.17
DOXYFILE
ENCODING
20.2
ENABLE
PREPROCESSING
20.15
ENUM
VALUES
PER
LINE
20.8
ENABLED
SECTIONS
20.3
EXAMPLE
PATH
20.5
EXAMPLE
PATTERNS
20.5
EXAMPLE
RECURSIVE
20.5
EXCLUDE
20.5
EXCLUDE
PATTERNS
20.5
EXCLUDE
SYMLINKS
20.5
EXPAND
AS
DEFINED
20.15
EXPAND
ONLY
PREDEF
20.15
EXTERNAL
GROUPS
20.16
EXTRA
PACKAGES
20.9
EXTRACT
ALL
20.3
EXTRACT
ANON
NSPACES
20.3
EXTRACT
LOCAL
CLASSES
20.3
EXTRACT
LOCAL
METHODS
20.3
EXTRACT
PRIVATE
20.3
EXTRACT
STATIC
20.3
FILE
PATTERNS
20.5
FILE
VERSION
FILTER
20.5
FILTER
PATTERNS
20.5
FILTER
SOURCE
FILES
20.5
FULL
PATH
NAMES
20.2
GENERATE
AUTOGEN
DEF
20.13
GENERATE
BUGLIST
20.3
GENERATE
CHI
20.8
GENERATE
DEPRECIATEDLIST
20.3
GENERATE
HTML
20.8
GENERATE
HTMLHELP
20.8
GENERATE
LATEX
20.9
GENERATE
LEGEND
20.17
GENERATE
MAN
20.11
GENERATE
PERLMOD
20.14
GENERATE
RTF
20.10
GENERATE
TAGFILE
20.16
GENERATE
TESTLIST
20.3
GENERATE
TODOLIST
20.3
GENERATE
TREEVIEW
20.8
GENERATE
XML
20.12
GRAPHICAL
HIERARCHY
20.17
GROUP
GRAPHS
20.17
HAVE
DOT
20.17
HHC
LOCATION
20.8
HIDE
FRIEND
COMPOUNDS
20.3
HIDE
IN
BODY
DOCS
20.3
HIDE
SCOPE
NAMES
20.3
HIDE
UNDOC
CLASSES
20.3
HIDE
UNDOC
MEMBERS
20.3
HIDE
UNDOC
RELATIONS
20.17
HTML
ALIGN
MEMBERS
20.8
HTML
DYNAMIC
SECTIONS
20.8
HTML
FOOTER
20.8
HTML
HEADER
20.8
HTML
OUTPUT
20.8
HTML
STYLESHEET
20.8
IGNORE
PREFIX
20.7
UserManualforDoxygen1.5.3,writtenbyDimitrivanHeesch
c
1997-2006
Convert word to pdf with bookmarks - add, remove, update PDF bookmarks in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your C# Project with Rapid PDF Internal Navigation Via Bookmark and Outline
convert excel to pdf with bookmarks; pdf bookmark
Convert word to pdf with bookmarks - VB.NET PDF bookmark library: add, remove, update PDF bookmarks in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your VB.NET Project with Rapid PDF Internal Navigation Via Bookmark and Outline
creating bookmarks in pdf documents; how to add bookmark in pdf
20.1 Format
59
IMAGE
PATH
20.5
INCLUDE
GRAPH
20.17
INCLUDE
PATH
20.15
INHERIT
DOCS
20.2
INLINE
INFO
20.3
INLINE
INHERITED
MEMB
20.2
INLINE
SOURCES
20.6
INPUT
20.5
INPUT
ENCODING
20.5
INPUT
FILTER
20.5
INTERNAL
DOCS
20.3
JAVADOC
AUTOBRIEF
20.2
LATEX
BATCHMODE
20.9
LATEX
CMD
NAME
20.9
LATEX
HEADER
20.9
LATEX
HIDE
INDICES
20.9
LATEX
OUTPUT
20.9
MACRO
EXPANSION
20.15
MAKEINDEX
CMD
NAME
20.9
MAN
EXTENSION
20.11
MAN
LINKS
20.11
MAN
OUTPUT
20.11
MAX
DOT
GRAPH
DEPTH
20.17
MAX
INITIALIZER
LINES
20.3
MSCGEN
PATH
20.17
MULTILINE
CPP
IS
BRIEF
20.2
OPTIMIZE
OUTPUT
FOR
C
20.2
OPTIMIZE
OUTPUT
JAVA
20.2
OUTPUT
DIRECTORY
20.2
OUTPUT
LANGUAGE
20.2
PAPER
TYPE
20.9
PDF
HYPERLINKS
20.9
PERL
PATH
20.16
PERLMOD
LATEX
20.14
PERLMOD
PRETTY
20.14
PERLMOD
MAKEVAR
PREFIX
20.14
PREDEFINED
20.15
PROJECT
NAME
20.2
PROJECT
NUMBER
20.2
QT
AUTOBRIEF
20.2
QUIET
20.4
RECURSIVE
20.5
REFERENCED
BY
RELATION
20.6
REFERENCES
RELATION
20.6
REFERENCES
LINK
SOURCE
20.6
REPEAT
BRIEF
20.2
RTF
EXTENSIONS
FILE
20.10
RTF
HYPERLINKS
20.10
RTF
OUTPUT
20.10
RTF
STYLESHEET
FILE
20.10
SEARCH
INCLUDES
20.15
SEARCHENGINE
20.18
SEPARATE
MEMBER
PAGES
20.2
SHORT
NAMES
20.2
SHOW
DIRECTORIES
20.3
SHOW
INCLUDE
FILES
20.3
SHOW
USED
FILES
20.3
SKIP
FUNCTION
MACROS
20.15
SORT
BRIEF
DOCS
20.3
SORT
MEMBER
DOCS
20.3
SOURCE
BROWSER
20.6
STRIP
CODE
COMMENTS
20.6
STRIP
FROM
INC
PATH
20.2
STRIP
FROM
PATH
20.2
SUBGROUPING
20.2
TAB
SIZE
20.2
TAGFILES
20.16
TEMPLATE
RELATIONS
20.17
TOC
EXPAND
20.8
TREEVIEW
WIDTH
20.8
UML
LOOK
20.17
USE
HTAGS
20.6
USE
PDFLATEX
20.9
USE
WINDOWS
ENCODING
20.2
User Manual forDoxygen1.5.3,written by Dimitri vanHeesch
c
1997-2006
VB.NET PDF File Compress Library: Compress reduce PDF size in vb.
Bookmarks. Comments, forms and multimedia. Convert smooth lines to curves. VB.NET Demo Code to Optimize An Exist PDF File in Visual C#.NET Project.
export pdf bookmarks to text; create bookmark pdf
C# PDF File Split Library: Split, seperate PDF into multiple files
Split PDF file by top level bookmarks. The following C# codes explain how to split a PDF file into multiple ones by PDF bookmarks or outlines.
add bookmark to pdf reader; how to add bookmarks to pdf document
20.2 Project related options
60
VERBATIM
HEADERS
20.6
WARN
FORMAT
20.4
WARN
IF
DOC
ERROR
20.4
WARN
IF
UNDOCUMENTED
20.4
WARN
LOGFILE
20.4
WARN
NO
PARAMDOC
20.4
WARNINGS
20.4
XML
DTD
20.12
XML
OUTPUT
20.12
XML
PROGRAMLISTING
20.12
XML
SCHEMA
20.12
20.2 Project related options
DOXYFILE
ENCODING This tag specifies the encoding used for all characters in the config file that
follow. The default is UTF-8 which is also the encoding used for all text before the first occur-
rence of this tag. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. See
http://www.gnu.org/software/libiconvforthelistofpossibleencodings.
PROJECT
NAME The PROJECT
NAME tag is a single word (or a sequence of words surrounded by
double-quotes) that should identify the project for which the documentation is generated. This name
is used in the title of most generated pages and in a few other places.
PROJECT
NUMBER The PROJECT
NUMBER tag can be used to enter a project or revision number. This
could be handy for archiving the generated documentation or if some version control system is used.
OUTPUT
DIRECTORY The OUTPUT
DIRECTORY tag is used to specify the (relative or absolute) path
into which the generated documentation will be written. If a relative path is entered, it will be relative
to the location where doxygen was started. If left blank the current directory will be used.
CREATE
SUBDIRS If the CREATE
SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
directories (in 2 levels) under the output directory of each output format and will distribute the
generated files over these directories. Enabling this option can be useful when feeding doxygen a
huge amount of source files, where putting all generated files in the same directory would otherwise
causes performance problems for the file system.
OUTPUT
LANGUAGE The OUTPUT
LANGUAGE tag is used to specify the language in which all docu-
mentation generated by doxygen is written. Doxygen will use this information to generate all con-
stant output in the proper language. The default language is English, other supported languages are:
Afrikaans, Arabic, Brazilian, Catalan, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
German, Greek, Hungarian, Italian, Japanese, Korean, Lithuanian, Norwegian, Persian, Polish, Por-
tuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
USE
WINDOWS
ENCODING This tag can be used to specify the encoding used in the generated output.
The encoding is not always determined by the language that is chosen, but also whether or not the
output is meant for Windows or non-Windows users. In case there is a difference, setting the USE
-
WINDOWS
ENCODING tag to YES forces the Windows encoding, (this isthe default for the Windows
binary), whereas setting the tag to NO uses a Unix-style encoding (the default for all platforms other
than Windows).
BRIEF
MEMBER
DESC If the BRIEF
MEMBER
DESC tag is set to YES (the default) doxygen will in-
clude brief member descriptions after the members that are listed in the file and class documentation
(similar to JavaDoc). Set to NO to disable this.
REPEAT
BRIEF If the REPEAT
BRIEF tag is set to YES (the default) doxygen will prepend the brief
description of a member or function before the detailed description
Note:
If both HIDE
UNDOC
MEMBERS and BRIEF
MEMBER
DESC are set to NO, the brief descrip-
tions will be completely suppressed.
User Manual forDoxygen1.5.3,written by Dimitri vanHeesch
c
1997-2006
VB.NET PDF File Split Library: Split, seperate PDF into multiple
Demo Code in VB.NET. The following VB.NET codes explain how to split a PDF file into multiple ones by PDF bookmarks or outlines.
how to bookmark a pdf file; create bookmark pdf file
C# PDF File Compress Library: Compress reduce PDF size in C#.net
Bookmarks. Comments, forms and multimedia. Hidden layer content. Convert smooth lines to curves. Flatten visible layers. C#.NET DLLs: Compress PDF Document.
convert word pdf bookmarks; auto bookmark pdf
20.2 Project related options
61
ABBREVIATE
BRIEF This tag implements a quasi-intelligent brief description abbreviator that is used
to form the text in various listings. Each string in this list, if found as the leading text of the brief
description, will be stripped from the text and the result after processing the whole list, is used as
the annotated text. Otherwise, the brief description is used as-is. If left blank, the following values
are used (”\$name” is automatically replaced with the name of the entity): ”The $name class” ”The
$name widget” ”The $name file” ”is” ”provides” ”specifies” ”contains” ”represents” ”a” ”an” ”the”.
ALWAYS
DETAILED
SEC If the ALWAYS
DETAILED
SEC and REPEAT
BRIEF tags are both set to
YES then doxygen will generate a detailed section even if there is only a brief description.
INLINE
INHERITED
MEMB If the INLINE
INHERITED
MEMB tag is set to YES, doxygen will show
all inherited members of a class in the documentation of that class as if those members were ordinary
class members. Constructors, destructors and assignment operators of the base classes will not be
shown.
FULL
PATH
NAMES If the FULL
PATH
NAMES tag is set to YES doxygen will prepend the full path
before files name in the file list and in the header files. If set to NO the shortest path that makes the
file name unique will be used
STRIP
FROM
PATH If the FULL
PATH
NAMES tag is set to YES then the STRIP
FROM
PATH tag can
be used to strip a user-defined part of the path. Stripping is only done if one of the specified strings
matches the left-hand part of the path. The tag can be used to show relative paths in the file list. If
left blank the directory from which doxygen is run is used as the path to strip.
STRIP
FROM
INC
PATH The STRIP
FROM
INC
PATH tag can be used to strip a user-defined part of
the path mentioned in the documentation of a class, which tells the reader which header file to include
in order to use a class. If left blank only the name of the header file containing the class definition is
used. Otherwise one should specify the include paths that are normally passed to the compiler using
the -I flag.
CASE
SENSE
NAMES If the CASE
SENSE
NAMES tag is set to NO then doxygen will only generate file
names in lower-case letters. If set to YES upper-case letters are also allowed. This is useful if you
have classes or files whose names only differ in case and if your file system supports case sensitive
file names. Windows users are advised to set this option to NO.
SHORT
NAMES If the SHORT
NAMES tag is set to YES, doxygen will generate much shorter (but less
readable) file names. This can be useful is your file systems doesn’t support long names like on
DOS, Mac, or CD-ROM.
JAVADOC
AUTOBRIEF If the JAVADOC
AUTOBRIEF is set to YES then doxygen will interpret the first
line (until the first dot) of a JavaDoc-style comment as the brief description. If set to NO (the default),
the Javadoc-style will behave just like regular Qt-style comments (thus requiring an explicit @brief
command for a brief description.)
QT
AUTOBRIEF If the QT
AUTOBRIEF is set to YES then doxygen will interpret the first line (until the
first dot) of a Qt-style comment as the brief description. If set to NO (the default), the Qt-style will
behave just like regular Qt-style comments (thus requiring an explicit \brief command for a brief
description.)
BUILTIN
STL
SUPPORT If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
to include (a tag file for) the STL sources as input, then you should set this tag to YES in order
to let doxygen match functions declarations and definitions whose arguments contain STL classes
(e.g. func(std::string); v.s. func(std::string) {}). This also make the inheritance and collaboration
diagrams that involve STL classes more complete and accurate.
CPP
CLI
SUPPORT If you use Microsoft’s C++/CLI language, you should set this option to YES to
enable parsing support.
User Manual forDoxygen1.5.3,written by Dimitri vanHeesch
c
1997-2006
C# PDF Convert to HTML SDK: Convert PDF to html files in C#.net
it extremely easy for C# developers to convert and transform document file, converted by C#.NET PDF to HTML all the original anchors, links, bookmarks and font
adding bookmarks in pdf; export pdf bookmarks
XDoc.Word for .NET, Advanced .NET Word Processing Features
Create Word from PDF; Create Word from OpenOffice (.odt); More about Word SDK Word Export. Convert Word to PDF; Convert Word to HTML5; Convert Word to Tiff; Convert
create bookmarks in pdf from excel; pdf create bookmarks
20.2 Project related options
62
DISTRIBUTE
GROUP
DOC If member grouping is used in the documentation and the DISTRIBUTE
-
GROUP
DOC tag is set to YES, then doxygen will reuse the documentation of the first member in
the group (if any) for the other members of the group. By default all members of a group must be
documented explicitly.
MULTILINE
CPP
IS
BRIEF The MULTILINE
CPP
IS
BRIEF tag can be set to YES to make Doxy-
gen treat a multi-line C++ special comment block (i.e. a block of //! or /// comments) as a brief
description. This used to be the default behaviour. The new default is to treat a multi-line C++ com-
ment block as a detailed description. Set this tag to YES if you prefer the old behaviour instead. Note
that setting this tag to YES also means that rational rose comments are not recognized any more.
DETAILS
AT
TOP If the DETAILS
AT
TOP tag is set to YES then Doxygen will output the detailed
description near the top, like JavaDoc. If set to NO, the detailed description appears after the member
documentation.
INHERIT
DOCS If the INHERIT
DOCS tag is set to YES (the default) then an undocumented member
inherits the documentation from any documented member that it re-implements.
SEPARATE
MEMBER
PAGES If the SEPARATE
MEMBER
PAGES tag is set to YES, then doxygen will
produce a new page for each member. If set to NO, the documentation of a member will be part of
the file/class/namespace that contains it.
TAB
SIZE the TAB
SIZE tag can be used to set the number of spaces in a tab. Doxygen uses this value
to replace tabs by spaces in code fragments.
ALIASES This tag can be used to specify a number of aliases that actsas commands in the documentation.
An alias has the form
name=value
For example adding
"sideeffect=\par Side Effects:\n"
will allow you to put the command \sideeffect (or @sideeffect) in the documentation, which will
result in a user-defined paragraph with heading ”Side Effects:”. You can put \n’s in the value part of
an alias to insert newlines.
OPTIMIZE
OUTPUT
FOR
C Set the OPTIMIZE
OUTPUT
FOR
Ctag to YES if your project consists of
Csources only. Doxygen will then generate output that is more tailored for C. For instance, some of
the names that are used will be different. The list of all members will be omitted, etc.
OPTIMIZE
OUTPUT
JAVA Set the OPTIMIZE
OUTPUT
JAVA tag to YES if your project consists of
Java or Python sources only. Doxygen will then generate output that is more tailored for that lan-
guage. For instance, namespaces will be presented as packages, qualified scopes will look different,
etc.
SUBGROUPING Set the SUBGROUPING tag to YES (the default) to allow class member groups of the
same type (for instance a group of public functions) to be put as a subgroup of that type (e.g. under
the Public Functions section). Set it to NO to prevent subgrouping. Alternatively, this can be done
per class using the\nosubgrouping command.
User Manual forDoxygen1.5.3,written by Dimitri vanHeesch
c
1997-2006
C# Word - Convert Word to HTML in C#.NET
VB.NET How-to, VB.NET PDF, VB.NET Word, VB toolkit SDK, preserves all the original anchors, links, bookmarks and font C#: Convert Word document to HTML5 files.
creating bookmarks pdf; copy bookmarks from one pdf to another
.NET PDF SDK - Description of All PDF Processing Control Feastures
Full page navigation, zooming & rotation; Outlines, bookmarks, & thumbnail display; PDF Export. Convert PDF to Word (.docx); Convert PDF to HTML; Convert PDF to
add bookmark pdf; bookmark pdf in preview
20.3 Build related options
63
20.3 Build related options
EXTRACT
ALL If the EXTRACT
ALL tag is set to YES doxygen will assume all entities in documenta-
tion are documented, even if no documentation was available. Private class members and static file
members will be hidden unless the EXTRACT
PRIVATE and EXTRACT
STATIC tags are set to
YES
Note:
This will also disable the warnings about undocumented members that are normally produced
when WARNINGS is set to YES
EXTRACT
PRIVATE If the EXTRACT
PRIVATE tag is set to YES all private members of a class will be
included in the documentation.
EXTRACT
STATIC If the EXTRACT
STATIC tag is set to YES all static members of a file will be in-
cluded in the documentation.
EXTRACT
LOCAL
CLASSES If the EXTRACT
LOCAL
CLASSES tag is set to YES classes (and structs)
defined locally in source files will be included in the documentation. If set to NO only classes defined
in header files are included. Does not have any effect for Java sources.
EXTRACT
ANON
NSPACES If this flag is set to YES, the members of anonymous namespaces will be
extracted and appear in the documentation as a namespace called ’anonymous
namespace{file}’,
where file will be replaced with the base name of the file that contains the anonymous namespace.
By default anonymous namespace are hidden.
EXTRACT
LOCAL
METHODS This flag is only useful for Objective-C code. When set to YES local meth-
ods, which are defined in the implementation section but not in the interface are included in the
documentation. If set to NO (the default) only methods in the interface are included.
HIDE
UNDOC
MEMBERS If the HIDE
UNDOC
MEMBERS tag is set to YES, doxygen will hide all undoc-
umented members inside documented classes or files. If set to NO (the default) these members will
be included in the various overviews, but no documentation section is generated. This option has no
effect if EXTRACT
ALL is enabled.
HIDE
UNDOC
CLASSES If the HIDE
UNDOC
CLASSESS tag is set to YES, doxygen will hide all un-
documented classes. If set to NO (the default) these classes will be included in the various overviews.
This option has no effect if EXTRACT
ALL is enabled.
HIDE
FRIEND
COMPOUNDS If the HIDE
FRIEND
COMPOUNDS tag is set to YES, Doxygen will hide
all friend (class|struct|union) declarations. If set to NO (the default) these declarations will be in-
cluded in the documentation.
HIDE
IN
BODY
DOCS If the HIDE
IN
BODY
DOCS tag is set to YES, Doxygen will hide any documen-
tation blocks found inside the body of a function. If set to NO (the default) these blocks will be
appended to the function’s detailed documentation block.
INTERNAL
DOCS The INTERNAL
DOCS tag determines if documentation that is typed after a\internal
command is included. If the tag is set to NO (the default) then the documentation will be excluded.
Set it to YES to include the internal documentation.
HIDE
SCOPE
NAMES If the HIDE
SCOPE
NAMES tag is set to NO (the default) then doxygen will show
members with their full class and namespace scopes in the documentation. If set to YES the scope
will be hidden.
SHOW
INCLUDE
FILES If the SHOW
INCLUDE
FILES tag is set to YES (the default) then doxygen
will put a list of the files that are included by a file in the documentation of that file.
User Manual forDoxygen1.5.3,written by Dimitri vanHeesch
c
1997-2006
20.4 Options related to warning and progress messages
64
INLINE
INFO If the INLINE
INFO tag is set to YES (the default) then a tag [inline] is inserted in the
documentation for inline members.
SORT
MEMBER
DOCS If the SORT
MEMBER
DOCS tag is set to YES (the default) then doxygen will sort
the (detailed) documentation of file and class members alphabetically by member name. If set to NO
the members will appear in declaration order.
SORT
BRIEF
DOCS If the SORT
BRIEF
DOCS tag is set to YES then doxygen will sort the brief de-
scriptions of file, namespace and class members alphabetically by member name. If set to NO (the
default) the members will appear in declaration order.
GENERATE
DEPRECATEDLIST The GENERATE
DEPRECATEDLIST tag can be used to enable
(YES) or disable (NO) the deprecated list. This list is created by putting\deprecated commands
in the documentation.
GENERATE
TODOLIST The GENERATE
TODOLIST tag can be used to enable (YES) or disable (NO)
the todo list. This list is created by putting\todo commands in the documentation.
GENERATE
TESTLIST The GENERATE
TESTLIST tag can be used to enable (YES) or disable (NO)
the test list. This list is created by putting\testcommands in the documentation.
GENERATE
BUGLIST The GENERATE
BUGLIST tag can be used to enable (YES) or disable (NO) the
bug list. This list is created by putting\bug commands in the documentation.
ENABLED
SECTIONS The ENABLED
SECTIONS tag can be used to enable conditional documentation
sections, marked by\if<section-label> ...\endifand\cond <section-label> ...\endcond blocks.
MAX
INITIALIZER
LINES The MAX
INITIALIZER
LINES tag determines the maximum number
of lines that the initial value of a variable or define can be. If the initializer consists of more lines than
specified here it will be hidden. Use a value of 0 to hide initializers completely. The appearance of the
value of individual variables and defines can be controlled using\showinitializeror\hideinitializer
command in the documentation.
SHOW
USED
FILES Set the SHOW
USED
FILES tag to NO to disable the list of files generated at the
bottom of the documentation of classes and structs. If set to YES the list will mention the files that
were used to generate the documentation.
SHOW
DIRECTORIES If the sources in your project are distributed over multiple directories then setting
the SHOW
DIRECTORIES tag to YES will show the directory hierarchy in the documentation.
20.4 Options related to warning and progress messages
QUIET The QUIET tag can be used to turn on/off the messages that are generated to standard output by
doxygen. Possible values are YES and NO, where YES implies that the messages are off. If left blank
NO is used.
WARNINGS The WARNINGS tag can be used to turn on/off the warning messages that are generated to
standard error by doxygen. Possible values are YES and NO, where YES implies that the warnings
are on. If left blank NO is used.
Tip: Turn warnings on while writing the documentation.
WARN
IF
UNDOCUMENTED If WARN
IF
UNDOCUMENTED is set to YES, then doxygen will generate
warnings for undocumented members. If EXTRACT
ALL is set to YES then this flag will automati-
cally be disabled.
WARN
IF
DOC
ERROR If WARN
IF
DOC
ERROR is set to YES, doxygen will generate warnings for po-
tential errors in the documentation, such as not documenting some parameters in a documented
function, or documenting parameters that don’t exist or using markup commands wrongly.
User Manual forDoxygen1.5.3,written by Dimitri vanHeesch
c
1997-2006
20.5 Input related options
65
WARN
NO
PARAMDOC This WARN
NO
PARAMDOC option can be abled to get warnings for functions that
are documented, but have no documentation for their parameters or return value. If set to NO (the
default) doxygen will only warn about wrong or incomplete parameter documentation, but not about
the absence of documentation.
WARN
FORMAT The WARN
FORMAT tag determines the format of the warning messages that doxygen can
produce. The string should contain the $file, $line, and $text tags, which will be replaced by
the file and line number from which the warning originated and the warning text.
WARN
LOGFILE The WARN
LOGFILE tag can be used to specify a file to which warning and error
messages should be written. If left blank the output is written to stderr.
20.5 Input related options
INPUT The INPUT tag is used to specify the files and/or directories that contain documented source
files. You may enter file names like myfile.cpp or directories like /usr/src/myproject.
Separate the files or directories with spaces.
Note: If this tag is empty the current directory is searched.
INPUT
ENCODING This tag can be used to specify the character encoding of the source files that doxy-
gen parses. Internally doxygen uses the UTF-8 encoding, which is also the default input encod-
ing. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. Seethe libiconv
documentationforthelistofpossibleencodings.
FILE
PATTERNS If the value of the INPUT tag contains directories, you can use the FILE
PATTERNS
tag to specify one or more wildcard patterns (like ∗.cpp and ∗.h ) to filter out the source-files in
the directories. If left blank the following patterns are tested: .c ∗.cc ∗.cxx ∗.cpp ∗.c++
∗.java ∗.ii ∗.ixx ∗.ipp ∗.i++ ∗.inl ∗.h ∗.hh ∗.hxx ∗.hpp .h++ ∗.idl
∗.odl ∗.cs ∗.php ∗.php3 ∗.inc ∗.m ∗.mm
FILE
VERSION
FILTER The FILE
VERSION
FILTER tag can be used to specify a program or
script that doxygen should invoke to get the current version for each file (typically from the ver-
sion control system). Doxygen will invoke the program by executing (via popen()) the command
command input-file, where command is the value of the FILE
VERSION
FILTER tag, and
input-file is the name of an input file provided by doxygen. Whatever the program writes to
standard output is used as the file version.
Example of using a shell script as a filter for Unix:
FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"
Example shell script for CVS:
#!/bin/sh
cvs status $1 | sed -n ’s/ˆ[ \]
*
Working revision:[ \t]
*
\([0-9][0-9\.]
*
\).
*
/\1/p’
Example shell script for Subversion:
#!/bin/sh
svn stat -v $1 | sed -n ’s/ˆ[ A-Z?\
*
|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .
*
//p’
Example filter for ClearCase:
FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
User Manual forDoxygen1.5.3,written by Dimitri vanHeesch
c
1997-2006
20.6 Source browsing related options
66
RECURSIVE The RECURSIVE tag can be used to specify whether or not subdirectories should be
searched for input files as well. Possible values are YES and NO. If left blank NO is used.
EXCLUDE The EXCLUDE tag can be used to specify files and/or directories that should excluded from
the INPUT source files. This way you can easily exclude a subdirectory from a directory tree whose
root is specified with the INPUT tag.
EXCLUDE
SYMLINKS The EXCLUDE
SYMLINKS tag can be used select whether or not files or directo-
ries that are symbolic links (a Unix filesystem feature) are excluded from the input.
EXCLUDE
PATTERNS If the value of the INPUT tag contains directories, you can use the EXCLUDE
-
PATTERNS tag to specify one or more wildcard patterns to exclude certain files from those directo-
ries.
Note that the wildcards are matched against the file with absolute path, so to exclude all test directo-
ries use the pattern ∗/test/∗
EXAMPLE
PATH The EXAMPLE
PATH tag can be used to specify one or more files or directories that
contain example code fragments that are included (see the \include command in section\include).
EXAMPLE
RECURSIVE If the EXAMPLE
RECURSIVE tag is set to YES then subdirectories will be
searched for input files to be used with the \include or \dontinclude commands irrespective of the
value of the RECURSIVE tag. Possible values are YES and NO. If left blank NO is used.
EXAMPLE
PATTERNS If the value of the EXAMPLE
PATH tag contains directories, you can use the
EXAMPLE
PATTERNS tag to specify one or more wildcard pattern (like ∗.cpp and ∗.h) to filter out
the source-files in the directories. If left blank all files are included.
IMAGE
PATH The IMAGE
PATH tag can be used to specify one or more files or directories that contain
images that are to be included in the documentation (see the\image command).
INPUT
FILTER The INPUT
FILTER tag can be used to specify a program that doxygen should invoke
to filter for each input file. Doxygen will invoke the filter program by executing (via popen()) the
command:
<filter> <input-file>
where <filter> is the value of the INPUT
FILTER tag, and <input-file> is the name of an input
file. Doxygen will then use the output that the filter program writes to standard output.
FILTER
PATTERNS The FILTER
PATTERNS tag can be used to specify filters on a per file pattern
basis. Doxygen will compare the file name with each pattern and apply the filter if there is a match.
The filters are a list of the form: pattern=filter (like ∗.cpp=my
cpp
filter). See INPUT
-
FILTER for further info on how filters are used. If FILTER
PATTERNS is empty, INPUT
FILTER
is applied to all files.
FILTER
SOURCE
FILES If the FILTER
SOURCE
FILES tag is set to YES, the input filter (if set using
INPUT
FILTER)willalsobeusedtofiltertheinputfilesthatareusedforproducingthesourcefiles
to browse (i.e. when SOURCE
BROWSER is set to YES).
20.6 Source browsing related options
SOURCE
BROWSER If the SOURCE
BROWSER tag is set to YES then a list of source files will be gener-
ated. Documented entities will be cross-referenced with these sources.
INLINE
SOURCES Setting the INLINE
SOURCES tag to YES will include the body of functions,
classes and enums directly into the documentation.
User Manual forDoxygen1.5.3,written by Dimitri vanHeesch
c
1997-2006
20.7 Alphabetical index options
67
STRIP
CODE
COMMENTS Setting the STRIP
CODE
COMMENTS tag to YES (the default) will instruct
doxygen to hide any special comment blocks from generated source code fragments. Normal C and
C++ comments will always remain visible.
REFERENCED
BY
RELATION If the REFERENCED
BY
RELATION tag is set to YES (the default) then
for each documented function all documented functions referencing it will be listed.
REFERENCES
RELATION If the REFERENCES
RELATION tag is set to YES (the default) then for each
documented function all documented entities called/used by that function will be listed.
REFERENCES
LINK
SOURCE If the REFERENCES
LINK
SOURCE tag is set to YES (the default) and
SOURCE
BROWSER tag is set to YES, then the hyperlinks from functions in REFERENCES
-
RELATION and REFERENCED
BY
RELATION lists will link to the source code. Otherwise they
will link to the documentstion.
VERBATIM
HEADERS If the VERBATIM
HEADERS tag is set the YES (the default) then doxygen will
generate a verbatim copy of the header file for each class for which an include is specified. Set to
NO to disable this.
See also:
Section\class.
USE
HTAGS If the USE
HTAGS tag is set to YES then the references to source code
will point to the HTML generated by the htags(1) tool instead of doxygen built-in
source browser.
The htags tool is part of GNU’s global source tagging system (see
http://www.gnu.org/software/global/global.html).Theuseitdothefollowing:
1. Install the latest version of global (i.e. 4.8.6 or better)
2. Enable SOURCE
BROWSER and USE
HTAGS in the config file
3. Make sure the INPUT points to the root of the source tree
4. Run doxygen as normal
Doxygen will invoke htags (and that will in turn invoke gtags), so these tools must be available from
the command line (i.e. in the search path).
The result: instead of the source browser generated by doxygen, the links to source code will now
point to the output of htags.
20.7 Alphabetical index options
ALPHABETICAL
INDEX If the ALPHABETICAL
INDEX tag is set to YES, an alphabetical index of all
compounds will be generated. Enable this if the project contains a lot of classes, structs, unions or
interfaces.
COLS
IN
ALPHA
INDEX If the alphabetical index is enabled (see ALPHABETICAL
INDEX) then the
COLS
IN
ALPHA
INDEX tag can be used to specify the number of columns in which this list will
be split (can be a number in the range [1..20])
IGNORE
PREFIX In case all classes in a project start with a common prefix, all classes will be put under
the same header in the alphabetical index. The IGNORE
PREFIX tag can be used to specify a prefix
(or a list of prefixes) that should be ignored while generating the index headers.
User Manual forDoxygen1.5.3,written by Dimitri vanHeesch
c
1997-2006
Documents you may be interested
Documents you may be interested