pdf to epub c# : Create pdf bookmark SDK control service wpf azure web page dnn doxygen7-part1714

20.8 HTMLrelatedoptions
68
20.8 HTMLrelatedoptions
GENERATE
HTML If the GENERATE
HTML tag is set to YES (the default) doxygen will generate HTML
output
HTML
OUTPUT The HTML
OUTPUTtag is used to specifywhere the HTML docs willbe put. If a relative
path is entered the value of OUTPUT
DIRECTORY will be put in front ofit. If left blank ‘html’will
be used as the default path.
HTML
FILE
EXTENSION The HTML
FILE
EXTENSION tag can be used to specify the file extension
for each generated HTML page (for example: .htm, .php, .asp). If it is left blank doxygen will
generate files with .html extension.
HTML
HEADER The HTML
HEADER tag can be used to specifya user-defined HTML headerfile for each
generated HTML page. To get valid HTML the header file should contain at least a <HTML> and
a<BODY> tag, but it is good idea to include the style sheet that is generated by doxygen as well.
Minimal example:
<HTML>
<HEAD>
<TITLE>My title</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
Ifthe tagis left blank doxygen will generate a standard header.
The following commands have a special meaning inside the header: $title, $datetime,
$date, $doxygenversion, $projectname,and $projectnumber. Doxygen will replace
them by respectively the title of the page, the current date and time, only the current date, the
version number of doxygen, the project name (see PROJECT
NAME), or the project number (see
PROJECT
NUMBER).
IfCREATE
SUBDIRS is enabled,the command $relpath$ canbe usedto produce a relative path
to the root of the HTML output directory, e.g. use $relpath$doxygen.css, to refer to the standard
style sheet.
See also sectionDoxygenusagefor information on how to generate the default header that doxygen
normallyuses.
HTML
FOOTER The HTML
FOOTER tag can be used to specify a user-defined HTML footer for each
generated HTML page. To getvalid HTML the footer file should contain at least a </BODY> and a
</HTML> tag. A minimal example:
</BODY>
</HTML>
Ifthe tagis left blank doxygen will generate a standard footer.
The following commands have aspecialmeaning insidethefooter: $title,$datetime,$date,
$doxygenversion, $projectname, $projectnumber. Doxygen will replace them by re-
spectivelythe title ofthepage, the current date and time, onlythecurrent date,the versionnumberof
doxygen, the project name (see PROJECT
NAME),or the project number(see PROJECT
NUMBER).
See also sectionDoxygenusagefor information on how to generate the default footer that doxygen
normallyuses.
HTML
STYLESHEET The HTML
STYLESHEET tagcan be usedtospecify auser-defined cascading style
sheet that is used by each HTML page. It can be used to fine-tune the look of the HTML output. If
the tag is left blank doxygen will generate a default style sheet.
See also sectionDoxygenusagefor information on how to generate the style sheet that doxygen
normallyuses.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
Create pdf bookmark - 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
create bookmarks pdf; add bookmark pdf file
Create pdf bookmark - 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
add bookmarks pdf; create bookmarks in pdf reader
20.8 HTML relatedoptions
69
HTML
ALIGN
MEMBERS If the HTML
ALIGN
MEMBERS tagis set to YES, the members ofclasses, files
or namespaces will be aligned in HTML using tables. If set to NO a bullet list will be used.
Note: Setting this tagto NO will become obsolete in the future,sinceI only intent tosupportand test
the aligned representation.
GENERATE
HTMLHELP If the GENERATE
HTMLHELP tag is set to YES then doxygen generates three
additional HTML index files: index.hhp, index.hhc, and index.hhk. The index.hhp is
aproject file that can be read byMicrosoft’s HTML Help Workshop on Windows.
The HTML Help Workshop contains a compiler that can convert all HTML output generated by
doxygen into a single compressed HTML file (.chm). Compressed HTML files are now used as
the Windows 98 help format, and will replace the old Windows help format (.hlp) on all Windows
platforms in the future. Compressed HTML files also contain an index, a table of contents, and
you can search for words in the documentation. The HTML workshop also contains a viewer for
compressed HTML files.
HTML
DYNAMIC
SECTIONS If the HTML
DYNAMIC
SECTIONS tag is set to YES then the generated
HTML documentation will contain sections that can be hidden and shown afterthe page has loaded.
For this to work a browser that supports JavaScript and DHTML is required (for instance Mozilla
1.0+, Firefox Netscape 6.0+, Internet explorer 5.0+, Konqueror, orSafari).
CHM
FILE If the GENERATE
HTMLHELP tag is set to YES, the CHM
FILE tag can be used to specify
the file name of the resulting .chmfile. You can add a path in front of the file if the result should not
be written to the html output directory.
HHC
LOCATION If the GENERATE
HTMLHELP tag is set to YES, the HHC
LOCATION tag can be used
to specify the location (absolute path including file name) of the HTML help compiler (hhc.exe). If
non empty doxygen will try to run the HTML help compiler on the generated index.hhp.
GENERATE
CHI Ifthe GENERATE
HTMLHELP tag is set to YES, the GENERATE
CHI flag controls if a
separate .chi index file is generated (YES) orthat it should be included in the master .chm file (NO).
BINARY
TOC If the GENERATE
HTMLHELP tag is set to YES, the BINARY
TOC flag controls whether
abinary table of contents is generated (YES) ora normal table of contents (NO) inthe .chm file.
TOC
EXPAND The TOC
EXPAND flag can be set to YES to add extra items for group members to the
table of contents of the HTML help documentation and to the tree view.
DISABLE
INDEX If you want full control over the layout of the generated HTML pages it might be
necessary to disable the index and replace it with your own. The DISABLE
INDEX tag can be used
to turn on/offthe condensed index at top ofeachpage. A value ofNO(the default)enables the index
and the value YESdisables it.
ENUM
VALUES
PER
LINE This tag can be used to set the number of enum values (range [1..20]) that
doxygen will group on one line in the generated HTML documentation.
GENERATE
TREEVIEW If the GENERATE
TREEVIEW tag is set to YES, a side panel will be generated
containinga tree-like indexstructure (just like the one that is generated forHTML Help). Forthis to
work a browser that supports JavaScript and frames is required (for instance Mozilla 1.0+,Netscape
6.0+ or Internet explorer 5.0+or Konqueror).
TREEVIEW
WIDTH If the treeviewis enabled (see GENERATE
TREEVIEW) then this tag can be used to
set the initial width (in pixels) ofthe frame in which the tree is shown.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
VB.NET Create PDF from Excel Library to convert xlsx, xls to PDF
Link: Edit URL. Bookmark: Edit Bookmark. Metadata: Edit, Delete Text. Add Text Box. Drawing Markups. PDF Print. Work Barcode Read. Barcode Create. OCR. Twain. Create
pdf bookmarks; create bookmark in pdf automatically
VB.NET Create PDF from Word Library to convert docx, doc to PDF in
Easy to create searchable and scanned PDF files from Word. Ability to get word count of PDF pages. Change Word hyperlink to PDF hyperlink and bookmark.
excel hyperlink to pdf bookmark; how to add a bookmark in pdf
20.9 LaTeXrelatedoptions
70
20.9 LaTeX related options
GENERATE
LATEX Ifthe GENERATE
LATEX tag is set to YES(the default) doxygenwillgenerate L
A
T
E
X
output.
LATEX
OUTPUT The LATEX
OUTPUT tag is used to specify where the LAT
E
Xdocs will be put. If a
relative path is entered the value of OUTPUT
DIRECTORY will be put in front of it. If left blank
‘latex’ will be used as the default path.
LATEX
CMD
NAME The LATEX
CMD
NAME tag can be used to specify the LaTeX command name to be
invoked. If left blank ‘latex’will be used as the default command name.
MAKEINDEX
CMD
NAME The MAKEINDEX
CMD
NAME tag can be used to specify the command
name to generate index for LaTeX. If left blank ‘makeindex’ will be used as the default command
name.
COMPACT
LATEX If the COMPACT
LATEX tag is set to YES doxygen generates more compact L
A
T
E
X
documents. This may be useful for small projects and may help to save some trees in general.
PAPER
TYPE The PAPER
TYPEtag can beused to setthe papertype thatis usedby the printer. Possible
values are:
• a4 (210 x 297 mm).
• a4wide (same as a4,but including the a4wide package).
• letter (8.5 x 11inches).
• legal (8.5 x 14 inches).
• executive (7.25x 10.5 inches)
Ifleft blank a4wide will be used.
EXTRA
PACKAGES The EXTRA
PACKAGES tag can be used to specify one or more L
A
T
E
Xpackage
names thatshould be includedin the L
A
T
E
Xoutput. To get the times font forinstance you can specify
EXTRA_PACKAGES = times
Ifleft blank no extra packages will be included.
LATEX
HEADER The LATEX
HEADER tag canbe used to specify a personal LAT
E
Xheader for the gener-
ated LAT
E
Xdocument. The header should contain everything until the first chapter.
Ifit isleft blankdoxygenwill generatea standard header. SeesectionDoxygenusageforinformation
on how to let doxygen write the default header to a separate file.
Note:
Only use a user-defined headerif you know what you are doing!
The following commands have a special meaning inside the header: $title, $datetime,
$date, $doxygenversion, $projectname, $projectnumber. Doxygen will replace
them by respectively the title of the page, the current date and time, only the current date, the
version number of doxygen, the project name (see PROJECT
NAME), or the project number (see
PROJECT
NUMBER).
PDF
HYPERLINKS If the PDF
HYPERLINKS tag is set to YES, the LAT
E
Xthat is generated is prepared
forconversion to PDF(using ps2pdf orpdflatex). The PDFfile willcontainlinks (just liketheHTML
output) instead of page references. This makes the output suitable for online browsing using a PDF
viewer.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
C# Create PDF from Word Library to convert docx, doc to PDF in C#.
Easy to create searchable and scanned PDF files from Word. Able to get word count in PDF pages. Change Word hyperlink to PDF hyperlink and bookmark.
create pdf with bookmarks from word; bookmarks pdf documents
VB.NET PDF Convert to Tiff SDK: Convert PDF to tiff images in vb.
Qualified Tiff files are exported with high resolution in VB.NET. Create multipage Tiff image files from PDF in VB.NET project. Support
export pdf bookmarks to excel; bookmarks in pdf
20.10 RTF relatedoptions
71
USE
PDFLATEX If the LATEX
PDFLATEX tag is set to YES, doxygen will use pdflatex to generate the
PDF file directly fromthe LAT
E
Xfiles.
LATEX
BATCHMODE If the LATEX
BATCHMODE tag is set to YES, doxygen will add the \batchmode.
commandtothegenerated LAT
E
Xfiles. This will instructLAT
E
Xtokeep running if errors occur,instead
of asking the user forhelp. This option is also used when generating formulas in HTML.
LATEX
HIDE
INDICES If LATEX
HIDE
INDICES is set to YES then doxygen will not include the
index chapters (such as File Index, Compound Index, etc.) in the output.
20.10 RTF related options
GENERATE
RTF If the GENERATE
RTF tag is set to YES doxygen will generate RTF output. The RTF
output is optimized for Word 97 and may not look too pretty with other readers/editors.
RTF
OUTPUT The RTF
OUTPUT tagis used to specify where the RTF docs will be put. If a relative path
is entered the value of OUTPUT
DIRECTORY will be put infront ofit. If leftblank rtf willbe used
as the default path.
COMPACT
RTF Ifthe COMPACT
RTF tagis settoYES doxygengenerates morecompactRTFdocuments.
This may be useful for small projects and may help to save some trees in general.
RTF
HYPERLINKS If the RTF
HYPERLINKS tag is set to YES, the RTF that is generated will con-
tain hyperlink fields. The RTF file will contain links (just like the HTML output) instead of page
references. This makes the output suitable for online browsing using Word or some other Word
compatible reader that support those fields.
note:
WordPad (write) and others do not support links.
RTF
STYLESHEET
FILE Load stylesheet definitions from file. Syntax is similar to doxygen’s config
file, i.e. a series of assignments. You only have to provide replacements, missing definitions are set
to their default value.
See also sectionDoxygenusagefor information on how to generate the default style sheet that
doxygen normally uses.
RTF
EXTENSIONS
FILE Set optional variables used in the generation of an RTF document. Syntax is
similar to doxygen’s config file. A template extensions file can be generated using doxygen -e
rtf extensionFile.
20.11 Man page related options
GENERATE
MAN Ifthe GENERATE
MAN tag is setto YES (the default) doxygen will generate man pages
for classes and files.
MAN
OUTPUT The MAN
OUTPUT tag is used to specify where the man pages will be put. If a relative
path is entered the value of OUTPUT
DIRECTORY will be put in front of it. If left blank ‘man’
will be used as the default path. A directory man3 will be created inside the directory specified by
MAN
OUTPUT.
MAN
EXTENSION The MAN
EXTENSION tag determines the extension that is added to the generated
man pages (default is the subroutine’s section .3)
MAN
LINKS IftheMAN
LINKS tag is setto YESand doxygengenerates manoutput,thenitwill generate
one additional man file for each entity documented in the real man page(s). These additional files
only source the real man page, but without them the man command would be unable to find the
correct page. The default is NO.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
C# Create PDF from Tiff Library to convert tif images to PDF in C#
Create PDF from Tiff. |. Home ›› XDoc.PDF ›› C# PDF: Create PDF from Tiff. Create PDF from Tiff in both .NET WinForms and ASP.NET application.
how to bookmark a page in pdf document; how to bookmark a pdf document
C# Create PDF from Excel Library to convert xlsx, xls to PDF in C#
C#.NET PDF SDK- Create PDF from Word in Visual C#. Online C#.NET Tutorial for Create PDF from Microsoft Office Excel Spreadsheet Using .NET XDoc.PDF Library.
bookmark page in pdf; create bookmarks pdf file
20.12 XML relatedoptions
72
20.12 XML related options
GENERATE
XML If the GENERATE
XML tag is set to YES Doxygen will generate an XML file that cap-
tures the structure of the code including all documentation.
XML
OUTPUT The XML
OUTPUT tag is used to specify where the XML pages will be put. If a relative
path is entered the value of OUTPUT
DIRECTORY will be put in front of it. If left blank xml will
be used as the default path.
XML
SCHEMA The XML
SCHEMA tag can be used to specify an XML schema, which can be used by a
validating XML parser to check the syntax of the XML files.
XML
DTD The XML
DTD tag can be used to specify an XML DTD, which can be used by a validating
XML parser tocheck the syntax of the XML files.
XML
PROGRAMLISTING Ifthe XML
PROGRAMLISTING tag is set to YES Doxygen willdump the pro-
gram listings (including syntax highlighting and cross-referencing information) to the XML output.
Note that enabling this will significantly increase the size of the XML output.
20.13 AUTOGEN
DEF related options
GENERATE
AUTOGEN
DEF If the GENERATE
AUTOGEN
DEF tag is set to YES Doxygen will generate
an AutoGen Definitions (seehttp://autogen.sf.net) file that captures the structure of the
code including all documentation. Note that this feature is still experimental and incomplete at the
moment.
20.14 PERLMOD related options
GENERATE
PERLMOD Ifthe GENERATE
PERLMOD tagis setto YES Doxygen willgenerate a Perl mod-
ule file that captures the structure of the code including all documentation. Note that this feature is
still experimental and incomplete at the moment.
PERLMOD
LATEX Ifthe PERLMOD
LATEXtag is set toYES Doxygenwill generate the necessaryMake-
file rules, Perl scripts and LaTeX code to be able to generate PDF and DVI output from the Perl
module output.
PERLMOD
PRETTY If the PERLMOD
PRETTY tag is set to YES the Perl module output will be nicely
formatted so it can be parsed by a human reader. This is useful if you want to understand what is
going on. On the other hand, if this tag is set to NO the size of the Perl module output will be much
smaller and Perl will parse it just the same.
PERLMOD
MAKEVAR
PREFIX The names of the make variables in the generated doxyrules.make file
are prefixed with the string contained in PERLMOD
MAKEVAR
PREFIX. This is useful so different
doxyrules.make files included by the same Makefile don’t overwrite each other’s variables.
20.15 Preprocessor related options
ENABLE
PREPROCESSING If the ENABLE
PREPROCESSING tag is set to YES (the default) doxygen
will evaluate all C-preprocessor directives found in the sources and include files.
MACRO
EXPANSION Ifthe MACRO
EXPANSIONtagis set to YES doxygenwill expand all macronames
in the source code. If set to NO (the default)only conditional compilation will be performed. Macro
expansion can be done in a controlled way by setting EXPAND
ONLY
PREDEF to YES.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
C# Create PDF from PowerPoint Library to convert pptx, ppt to PDF
C#.NET PDF SDK- Create PDF from PowerPoint in C#. How to Use C#.NET PDF Control to Create PDF from Microsoft PowerPoint Presentation in .NET Project.
bookmark a pdf file; editing bookmarks in pdf
C# Create PDF from images Library to convert Jpeg, png images to
Create PDF from Images. |. Home ›› XDoc.PDF ›› C# PDF: Create PDF from Images. C#.NET PDF - Create PDF from Images in C# with XDoc.NET PDF Control.
delete bookmarks pdf; bookmarks pdf file
20.16 External reference options
73
EXPAND
ONLY
PREDEF If the EXPAND
ONLY
PREDEF and MACRO
EXPANSION tags are both set
to YES then the macro expansion is limited to the macros specified with the PREDEFINED and
EXPAND
AS
DEFINED tags.
SEARCH
INCLUDES If the SEARCH
INCLUDES tag is set to YES (the default) the includes files in the
INCLUDE
PATH (see below) will be searched if a #include is found.
INCLUDE
PATH The INCLUDE
PATH tag can be used to specify one or more directories that contain
include files that are not input files but should be processed by the preprocessor.
PREDEFINED The PREDEFINED tag can be used to specify one or more macro names that are defined
before the preprocessor is started (similar to the -D option of gcc). The argument of the tag is a list
of macros of the form: name or name=definition (no spaces). If the definition and the ”=”
are omitted, ”=1” is assumed. To prevent a macro definition from being undefined via #undef or
recursively expanded use the := operator instead of the =operator.
EXPAND
AS
DEFINED If the MACRO
EXPANSION and EXPAND
ONLY
PREDEF tags are set to YES
then this tag can be used to specify a list of macro names that should be expanded. The macro
definition that is found in the sources will be used. Use the PREDEFINED tag if you want to use a
different macro definition.
SKIP
FUNCTION
MACROS If the SKIP
FUNCTION
MACROS tagis set toYES (the default)then doxy-
gen’s preprocessor willremoveallfunction-likemacrosthatare alone on aline,have anall uppercase
name, and do not end with a semicolon. Such function macros are typically used for boiler-plate
code, and will confuse the parserif not removed.
20.16 External reference options
TAGFILES The TAGFILES tag can be used to specify one or more tagfiles.
See sectionDoxytagusagefor more information about the usage of tag files.
Optionally aninitiallocation of the externaldocumentation canbe addedforeach tagfile. The format
of a tag file without this location is as follows:
TAGFILES = file1 file2 ...
Adding location forthe tag files is done as follows:
TAGFILES = file1=loc1 "file2 = loc2" ...
where loc1 and loc2 can be relative or absolute paths or URLs, If a location is present for each
tag, the installdox tool (see sectionInstalldoxusage for more information) does not have to be run to
correct the links.
Note:
Each tag file must have a unique name (where the name does not include the path) If a tag file is
not locatedin the directory in which doxygenis run,youmustalso specify the pathto the tagfile
here.
GENERATE
TAGFILE When a file name is specified after GENERATE
TAGFILE, doxygen will create
atag file that is based on the input files it reads. See sectionDoxytagusagefor more information
about the usage of tag files.
ALLEXTERNALS If the ALLEXTERNALS tag is set to YES all external class will be listed in the class
index. If set to NO only the inherited external classes will be listed.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
20.17 Dot options
74
EXTERNAL
GROUPS If the EXTERNAL
GROUPS tag is set to YES all external groups will be listed in
the modules index. If set to NO,only the current project’s groups will be listed.
PERL
PATH The PERL
PATH shouldbe the absolute path and name of the perl script interpreter(i.e. the
result of‘which perl’).
20.17 Dot options
CLASS
DIAGRAMS If the CLASS
DIAGRAMS tag is set to YES (the default) doxygen will generate a
class diagram (in HTML and L
A
T
E
X) for classes with base or super classes. Setting the tag to NO
turns the diagrams off. Note that this option is superseded by the HAVE
DOT option below. This is
only a fallback. It is recommended to install and use dot,since it yields more powerful graphs.
MSCGEN
PATH You candefine message sequence charts within doxygen comments using the\msccom-
mand. Doxygen will then run themsgen tool)to produce the chart and insert it in the documen-
tation. The MSCGEN
PATH tag allows youto specify the directory where the mscgen tool resides. If
left empty the tool is assumed to be found in the default search path.
HAVE
DOT If you set the HAVE
DOT tag to YES then doxygen will assume the dot tool is available from
the path. This tool is part ofGraphviz, a graph visualization toolkit from AT&T and Lucent Bell
Labs. The other options in this section have no effect if this option is set to NO (the default)
CLASS
GRAPH If the CLASS
GRAPH and HAVE
DOT tags are set to YES then doxygen will generate a
graph for each documented class showing the direct and indirect inheritance relations. Setting this
tag to YES will force the the CLASS
DIAGRAMS tag to NO.
COLLABORATION
GRAPH If the COLLABORATION
GRAPH and HAVE
DOT tags are set to YES then
doxygen will generate a graph foreach documented class showing the directand indirectimplemen-
tation dependencies (inheritance,containment,and class references variables)of the class with other
documented classes.
GROUP
GRAPHS If the GROUP
GRAPHS and HAVE
DOT tags are set to YES then doxygen will gen-
erate a graph for groups, showing the direct groups dependencies.
UML
LOOK If the UML
LOOK tag is set to YES doxygen will generate inheritance and collaboration
diagrams in a style similar to the OMG’s Unified Modeling Language.
TEMPLATE
RELATIONS IftheTEMPLATE
RELATIONSandHAVE
DOTtags are settoYES thendoxy-
gen will show the relations between templates and theirinstances.
HIDE
UNDOC
RELATIONS If set to YES,the inheritance and collaboration graphs will hide inheritance
and usage relations if the target is undocumented or is not a class.
INCLUDE
GRAPH If the ENABLE
PREPROCESSING, SEARCH
INCLUDES, INCLUDE
GRAPH, and
HAVE
DOT tags are set toYES then doxygenwill generate a graph foreach documentedfile showing
the direct and indirect include dependencies ofthe file with other documented files.
INCLUDED
BY
GRAPH If the ENABLE
PREPROCESSING, SEARCH
INCLUDES, INCLUDED
BY
-
GRAPH,andHAVE
DOT tags are set to YES then doxygenwill generate agraphforeachdocumented
header file showing the documented files that directly or indirectly include this file.
CALL
GRAPH If the CALL
GRAPH and HAVE
DOT tags are set to YES then doxygen will generate a call
dependency graph for every global function or class method. Note that enabling this option will
significantly increase the time of a run. So in most cases it will be better to enable call graphs for
selected functions only using the \callgraph command.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
20.18 Searchengine options
75
CALLER
GRAPH If the CALLER
GRAPH andHAVE
DOT tags are set to YES then doxygen will generate
acaller dependency graph for every global function or class method. Note that enabling this option
will significantly increase the time of a run. So in most cases it will be better to enable caller graphs
for selected functions only using the \callergraph command.
GRAPHICAL
HIERARCHY If the GRAPHICAL
HIERARCHY and HAVE
DOT tags are set to YES then
doxygen will graphical hierarchy of all classes instead of a textual one.
DIRECTORY
GRAPH If the DIRECTORY
GRAPH, SHOW
DIRECTORIES and HAVE
DOT options are
set toYES thendoxygen will showthe dependencies adirectoryhas onotherdirectoriesina graphical
way. The dependency relations are determined by the #include relations between the files in the
directories.
DOT
GRAPH
MAX
NODES TheMAX
DOT
GRAPH
MAX
NODEStagcanbeusedtoset themaximumnum-
ber of nodes that will be shown in the graph. If the number of nodes in a graph becomes larger than
this value, doxygen will truncate the graph, which is visualized by representing a node as a red box.
Note that doxygen if the number of direct children of the root node in a graph is already larger than
MAX
DOT
GRAPH
NOTES then the graph will not be shown at all. Also note that the size of a graph
can be furtherrestricted by MAX
DOT
GRAPH
DEPTH.
MAX
DOT
GRAPH
DEPTH The MAX
DOT
GRAPH
DEPTH tag can be used to set the maximum depth of
the graphs generated by dot. A depth value of 3 means that only nodes reachable from the root by
following a path via at most3 edges will be shown. Nodes that lay furtherfromthe root node willbe
omitted. Note that setting this option to 1 or 2 may greatly reduce the computation time needed for
large code bases. Also note that the size of a graph can be furtherrestricted by DOT
GRAPH
MAX
-
NODES. Using a depth of 0 means no depth restriction (the default).
DOT
IMAGE
FORMAT The DOT
IMAGE
FORMAT tag can be used to set the image format of the images
generated by dot. Possible values are gif, jpg,and png. Ifleft blank png will be used.
DOT
PATH This tag can be used to specify the path where the dot tool can be found. If left blank, it is
assumed the dot tool can be found on the path.
DOTFILE
DIRS This tag can be used to specify one or more directories that contain dot files that are
included in the documentation (see the \dotfile command).
DOT
TRANSPARENT Set the DOT
TRANSPARENT tag to YES to generate images with a transparent
background. This is disabled by default, which results in a white background. Warning: Depending
on the platform used, enabling this option may lead to badly anti-aliased labels on the edges of a
graph (i.e. they become hard to read).
DOT
MULTI
TARGETS Set the DOT
MULTI
TARGETS tagto YES allow dot to generate multiple output
files in one run (i.e. multiple -o and -T options on the command line). This makes dot run faster,but
since only newer versions of dot (>1.8.10) support this, this feature is disabledby default.
GENERATE
LEGEND Ifthe GENERATE
LEGEND tag is set to YES (the default) doxygen will generate a
legend page explaining the meaning ofthe various boxes and arrows in the dot generated graphs.
DOT
CLEANUP Ifthe DOT
CLEANUP tagis settoYES(the default)doxygen willremove the intermediate
dot files that are used to generate the various graphs.
20.18 Search engine options
SEARCHENGINE The SEARCHENGINE tag specifies whether or not the HTML output should con-
tain a search facility. Possible values are YES and NO. If set to YES, doxygen will pro-
duce a search index and a PHP script to search through the index. For this to work the doc-
umentation should be viewed via a web-server running PHP version 4.1.0 or higher. (See
http://www.php.net/manual/en/installation.phpforinstallationinstructions).
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
20.18 Searchengine options
76
Examples
Suppose you have a simple project consisting of two files: a source file example.cc and a header file
example.h. Then a minimal configuration file is as simple as:
INPUT
= example.cc example.h
Assuming the example makes use of Qt classes and perl is located in /usr/bin, a more realistic config-
uration file would be:
PROJECT_NAME
= Example
INPUT
= example.cc example.h
WARNINGS
= YES
TAGFILES
= qt.tag
PERL_PATH
= /usr/bin/perl
SEARCHENGINE
= NO
To generate the documentation for theQdbtTabular package I have used the following configuration
file:
PROJECT_NAME
= QdbtTabular
OUTPUT_DIRECTORY = html
WARNINGS
= YES
INPUT
= examples/examples.doc src
FILE_PATTERNS
=
*
.cc
*
.h
INCLUDE_PATH
= examples
TAGFILES
= qt.tag
PERL_PATH
= /usr/local/bin/perl
SEARCHENGINE
= YES
To regenerate the Qt-1.44 documentation from the sources, you could use the following config file:
PROJECT_NAME
= Qt
OUTPUT_DIRECTORY
= qt_docs
HIDE_UNDOC_MEMBERS
= YES
HIDE_UNDOC_CLASSES
= YES
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION
= YES
EXPAND_ONLY_PREDEF
= YES
SEARCH_INCLUDES
= YES
FULL_PATH_NAMES
= YES
STRIP_FROM_PATH
= $(QTDIR)/
PREDEFINED
= USE_TEMPLATECLASS Q_EXPORT= \
QArrayT:=QArray \
QListT:=QList \
QDictT:=QDict \
QQueueT:=QQueue \
QVectorT:=QVector \
QPtrDictT:=QPtrDict \
QIntDictT:=QIntDict \
QStackT:=QStack \
QDictIteratorT:=QDictIterator \
QListIteratorT:=QListIterator \
QCacheT:=QCache \
QCacheIteratorT:=QCacheIterator \
QIntCacheT:=QIntCache \
QIntCacheIteratorT:=QIntCacheIterator \
QIntDictIteratorT:=QIntDictIterator \
QPtrDictIteratorT:=QPtrDictIterator
INPUT
= $(QTDIR)/doc \
$(QTDIR)/src/widgets \
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
77
$(QTDIR)/src/kernel \
$(QTDIR)/src/dialogs \
$(QTDIR)/src/tools
FILE_PATTERNS
=
*
.cpp
*
.h q
*
.doc
INCLUDE_PATH
= $(QTDIR)/include
RECURSIVE
= YES
For the Qt-2.1 sources I recommend to use the following settings:
PROJECT_NAME
= Qt
PROJECT_NUMBER
= 2.1
HIDE_UNDOC_MEMBERS
= YES
HIDE_UNDOC_CLASSES
= YES
SOURCE_BROWSER
= YES
INPUT
= $(QTDIR)/src
FILE_PATTERNS
=
*
.cpp
*
.h q
*
.doc
RECURSIVE
= YES
EXCLUDE_PATTERNS
=
*
codec.cpp moc_
* *
/compat/
* *
/3rdparty/
*
ALPHABETICAL_INDEX
= YES
COLS_IN_ALPHA_INDEX
= 3
IGNORE_PREFIX
= Q
ENABLE_PREPROCESSING
= YES
MACRO_EXPANSION
= YES
INCLUDE_PATH
= $(QTDIR)/include
PREDEFINED
= Q_PROPERTY(x)= \
Q_OVERRIDE(x)= \
Q_EXPORT= \
Q_ENUMS(x)= \
"QT_STATIC_CONST=static const " \
_WS_X11_ \
INCLUDE_MENUITEM_DEF
EXPAND_ONLY_PREDEF
= YES
EXPAND_AS_DEFINED
= Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \
Q_VARIANT_AS
Here doxygen’s preprocessor is used to substitute some macro names that are normally substituted by the
Cpreprocessor,but without doing full macro expansion.
21 Special Commands
21.1 Introduction
All commands in the documentation start with a backslash (\) or an at-sign (@). If you prefer you can
replace all commands starting with a backslash below by their counterparts that start with an at-sign.
Some commands have one ormore arguments. Each argument has a certain range:
• If<sharp> braces are used the argument is a single word.
• If(round)braces are used the argument extends until the end ofthe line on which the commandwas
found.
• If {curly} braces are used the argument extends until the next paragraph. Paragraphs are delimited
by a blank line or by a section indicator.
If [square] brackets are used the argument is optional.
Here is an alphabetically sorted list of all commands with references to theirdocumentation:
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
Documents you may be interested
Documents you may be interested