作者:empty 页数:324 出版社:empty |
empty
Contents
I User Manual
1 Introduction
2 Installation
3 GettingStarted
4 Documenting the code
5 Markdown
6 Lists
7 Grouping
8 Including Formulas
9 Including Tables
Comp i ing from source on UNIX.
Installing the binaries on UNIX.
Comping fram source on Windows.
Installing the bin anes on Windows.
Sie pO; Check if doxygen sup parts your programming language
Step1:Creatingacontigurationile
Step2:Runningdoxygen.
3.3.1HTML output.
3.3.2 LaTeX output
3.3.3RTF output
3.3.4XML output.
3.3.5Man page output 7
3.3.6 DocBook output.
Step3:Documentingthesources,
Special comment blocks
4.1.3 Comment blocks in VHDL.
4.1.5 Comment blocks in Tcl.
Anatomy ota comment block
Standard Markdown
5.1.2 Headers.
5.1.3 Blockquotes.
5.1.5 Code Blocks.
5.1.6 Horizontal Rulers
5.1.7 Emphasis.
5.1.8codespans
5.1.9 Links, .i,
5.1.10 Images,
5.1.11 Automatic Linking.
Markdown Extensions.
5.2.4HeaderId Attributes
Doxygen specifics.
5.3.3 Code Black Indentation.
5.3.5CodeSpans Limits
5.3.6 Lists Extensions.
5.3.7Use of asterisks.
5.3.8 Limits on markup scope.
Debugging of problems.
Modules.
Member Groups
Sub paging.
Comment blocks for C like languages(C/C++/C#/Objec live C/PHP/Java)
Put ig documentation after members.
Examples.
Document at on at other places,
Comment blocks in Python
Comment blocks in Fortran
Paragraphs
Lists.
Inline Links
Reference Links,
TableofContents.
Tables.
Fenced Code Blocks
Including Markdown files as pages
Treatment ol HTML blocks.
Emphasis lim is.
10 Graphs and diagrams
11 Preprocessing
12 Automatic I ink generation
12.1 Links to webpages and mail addresses.
12.2 Links to classes
12.3Linkstofles.
12.4 Links to functions,
12.5 Links to other members
12.6 typedefs
13 Output Formats
14 Searching
14.1Extornal Indexing and Searching.
15 Customizing the Output
15.1 Minor Tweaks,
15.2 Changing the layout of pages.
15.3 Using the XML output
16 Custom Commands
16.1 Simple aliases.
16.2 Aliases with arguments.
16.3 Nesting custom command.
17 Link to external documentation
18 FrequentlyAskedQuestions
Genet seed by Du xy pen 1.8.13
14.1.1 Introduction
14.1.2 Configuring
14.1.3 Updating the index
14.1.4 Programming interface
15.1.1 Overall Color.
15.1.2 Navigation,
15.1.3 Dynamic Content.
Single project index
Multiproject index
Indexer input format.
Search URL format.
Search ro sults format.
15.1.4 Header, Footer, and Stylesheet changes.
proven t that at a certain place?.
18.1Howloget information on the index page in HTML?
18.2 Help, some/all of the members of my class/tile/namespace are not documented?.
18.3WhenIset EXTRACT_ALL to NOn one of my functions are shown in the documentation.
18.4My file with a custom extension is not parsed(properly) f anymore) .
18.5HowcanI make doxygen ignore some code fragment?.
18.6Howcanl change what i safer the code#include /code>in the class documentation?,
18.7Howcanlusetag files in combination with compressed HTML?.
18.8Idont like the quick index that is put above each HTML page, what dol do?.
18.9 The overall HTML output looks dit ferent, while l only wanted to use my own html header file
18.10WhydoesdoxygenuseQi?.
18.11Howcanl exclude all test directories from my directory tree?.
18.12Doxygenautomaic all generates a link to the class My Class some whore in the running text.How dol
18.13Myfavate programming language is X.Can Is til used oxygen?.,88
18.14 Help!I get the cryptic message inputbuffer overt low, cant enlarge buffer because scanner uses
REJECT.88
18.15Whenrunnig make in the latex dil get'TeX capacity exceeded.Now what?88
18.16Why are dependencies via STL classes not shown in the dot graphs?, ,88
18.17I have problems getting the search enginctoworkwithPHP5andl or windows.89
18.18CanI configured oxygen from the commandline?89
18.19Howdiddaxygengetits name?89
18.20 What was the reason to develop dax y gen?.89
19 Troubleshooting91
19.1 Known Problems,91
19.2How to Help,92
19.3How to report a bug.92
I Reference Manual93
20 Features95
21D oxygen usage97
21.1Fine-tuning the output.97
22 Doxywizard usage99
23 Configuration105
23.1 Format.105
23.2 Project related contig uration options.107
23.3Buid related configuration options.112
23.4 Configuration options related to warning and progress messages.115
GunataledbyDaxygen 1.8.13
23.5Coni guration options related lo the input files,
23.6 Configuration a ptions related to source browsing.
23.7Conigurationaptionsf elated to the alphabetical class index
23.8 Configuration options related to the HTML output.
23.9 Configuration options related to the LaTeX output,
23.10 Configuration options related to the RTF output.
23.11 Configuration options related to the manpage output.
23.12Conli guration options related to the XML output.
23.13Conigurationaptions related to the DOCBOOK output.
23.14 Configuration options for the AutoGen Deti nitions output
23.15Coni guration options related to the Perlmodule output.
23.16 Configuration options related to the preprocessor,
23.17 Configuration options related to external references.
23.18 Configuration options related to the dot tool, ,
23.19Examplos
24 Special Commands
24.1 Introduction.
24.2add to group name[(title) ] :
24.3 cal graph.
24.4Ahidec all graph.
24.5 call or graph
24.6thide caller graph.
24.7 cal egory s name>[c header-ile>] [ header-name>l
24.8 class cname>[ header-tile>lIc header-name>] .
24.9def name>
24.10 def group name>(group titie} .
24.11 dir[ path fragment>] .
24.12enum name>.
24.13 example file-name
24.14 end in tem nal,
24.15lextendsc name>
24.16 file[ name>] .
24.17fn(funct on declaration) .
24.18theaderfec header-file>[ header-name>]
24.19 hide in ilia liz er.
24.20idlexceptc name>
24.21 implements cname>.
24.22in group( group name>f group name> group name>D.
24.23 interface name>[ header-file>] [ header-name>] .-149
GsnerseedbyDuxyoen 1.8.13
MICONTENTS
24.24 internal.150
24.25 mainpage[it le]150
24.26 member of name.150
24.27A name[(header) ] .151
24.28 namespace name>151
24.29 no sub grouping151
24.30l overload[(function declaration) 】.151
24.31 package name>.152
24.32 page name(title) .152
24.33 private.152
24.34 private section.153
24.35 property(qualifed property name).153
24.36A protected.153
24.37 protected section.153
24.38 protocol name>[c header-e>] [ header-name>] .153
24.39 public.154
24.40 public section154
24.41pure, +.154
24.42A relates name>154
24.43 related name>155
24.44 relates also name>155
24.45 related also name>155
24.46 show initializer,,-155
24.47 static.155
24.48 struct name[c header-fle>] [c header-name>]155
24.49 typedef(lyp edef declaration) .156
24.50 unl on cname>[c header-fle>] [s header-name>] .156
24.51 var(variable declaration) .156
24.52whdilowRtile for the flowchart] .156
24.53weakgroupc name>(tle) :156
24.54 attention{attention text} .156
24.551 author(list ol authors) .157
24.56 authors{list of authors}157
24.57 brief(brief description} :157
24.58bug(bug description)157
24.59 cond[[section-label.157
24.60A copyright{copyright descripton} .158
24.61A d