doxygen manual 1.7.1

Download Doxygen Manual 1.7.1

Post on 14-Jul-2015

74 views

Category:

Documents

0 download

Embed Size (px)

TRANSCRIPT

Manual for version 1.7.1 Written by Dimitri van Heesch c 1997-2007

ContentsI User Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

45 5 7 7 9 10 10 12 13 14 16 17 17 22 23 25 26 27 28 30 30 33 34 35 37 40 44 44 44 44 45 45 47 49

1 Installation 1.1 Compiling from source on Unix . . . . 1.2 Installing the binaries on Unix . . . . . 1.3 Known compilation problems for Unix 1.4 Compiling from source on Windows . . 1.5 Installing the binaries on Windows . . . 1.6 Tools used to develop doxygen . . . . .

2 Getting Started 2.1 Step 1: Creating a conguration le . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.2 Step 2: Running doxygen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.3 Step 3: Documenting the sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Documenting the code 3.1 Special documentation blocks . . . . . 3.2 Putting documentation after members . 3.3 Documentation at other places . . . . . 3.4 Special documentation blocks in Python 3.5 Special documentation blocks in VHDL 3.6 Special documentation blocks in Fortran 4 Lists

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

5 Grouping 5.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.2 Member Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.3 Subpaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 7 8 Including Formulas Graphs and diagrams Preprocessing

9 Automatic link generation 9.1 Links to web pages and mail addresses . . . . . . . . . . . . . . 9.2 Links to classes. . . . . . . . . . . . . . . . . . . . . . . . . . . 9.3 Links to les. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9.4 Links to functions. . . . . . . . . . . . . . . . . . . . . . . . . . 9.5 Links to variables, typedefs, enum types, enum values and denes. 9.6 typedefs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Output Formats

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

CONTENTS

2

10.1

Output Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49 50 53 53 54 56 57 57 57 58 59 61 65

11 Searching 12 Customizing the Output 12.1 Minor Tweaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12.2 Changing the layout of pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12.3 Using the XML output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Custom Commands 13.1 Simple aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.2 Aliases with arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.3 Nesting custom command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Link to external documentation 15 Frequently Asked Questions 16 Troubleshooting

II

Reference Manual

6869 71 73 75 77 78 78 80 83 86 86 88 89 89 93 94 95 95 95 96 96 97 97 102 102 103 104

17 Features 18 Doxygen usage 19 Doxytag usage 20 Doxywizard usage 21 Installdox usage 22 Conguration 22.1 Format . . . . . . . . . . . . . . . . . . . . . . . 22.2 Project related options . . . . . . . . . . . . . . . 22.3 Build related options . . . . . . . . . . . . . . . . 22.4 Options related to warning and progress messages . 22.5 Input related options . . . . . . . . . . . . . . . . 22.6 Source browsing related options . . . . . . . . . . 22.7 Alphabetical index options . . . . . . . . . . . . . 22.8 HTML related options . . . . . . . . . . . . . . . 22.9 LaTeX related options . . . . . . . . . . . . . . . 22.10 RTF related options . . . . . . . . . . . . . . . . . 22.11 Man page related options . . . . . . . . . . . . . . 22.12 XML related options . . . . . . . . . . . . . . . . 22.13 AUTOGEN DEF related options . . . . . . . . . . 22.14 PERLMOD related options . . . . . . . . . . . . . 22.15 Preprocessor related options . . . . . . . . . . . . 22.16 External reference options . . . . . . . . . . . . . 22.17 Dot options . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

23 Special Commands 23.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2 \addtogroup [(title)] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.3 \callgraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

User Manual for Doxygen 1.7.1, written by Dimitri van Heesch c 1997-2006

CONTENTS

3

23.4 23.5 23.6 23.7 23.8 23.9 23.10 23.11 23.12 23.13 23.14 23.15 23.16 23.17 23.18 23.19 23.20 23.21 23.22 23.23 23.24 23.25 23.26 23.27 23.28 23.29 23.30 23.31 23.32 23.33 23.34 23.35 23.36 23.37 23.38 23.39 23.40 23.41 23.42 23.43 23.44 23.45 23.46 23.47 23.48 23.49 23.50 23.51 23.52 23.53 23.54 23.55 23.56 23.57

\callergraph . . . . . . . . . . . . . . . . . . . . . . . . . . \category [] [] . . . \class [] [] . . . . . \def . . . . . . . . . . . . . . . . . . . . . . . . . \defgroup (group title) . . . . . . . . . . . . . . . \dir [] . . . . . . . . . . . . . . . . . . . \enum . . . . . . . . . . . . . . . . . . . . . . . \example . . . . . . . . . . . . . . . . . . . . \extends . . . . . . . . . . . . . . . . . . . . . . \le [] . . . . . . . . . . . . . . . . . . . . . . . . \fn (function declaration) . . . . . . . . . . . . . . . . . . . \headerle [] . . . . . . . . \hideinitializer . . . . . . . . . . . . . . . . . . . . . . . . \implements . . . . . . . . . . . . . . . . . . . . \ingroup ( [ ]) \interface [] [] . . \internal . . . . . . . . . . . . . . . . . . . . . . . . . . . \mainpage [(title)] . . . . . . . . . . . . . . . . . . . . . . \memberof . . . . . . . . . . . . . . . . . . . . . \name (header) . . . . . . . . . . . . . . . . . . . . . . . . \namespace . . . . . . . . . . . . . . . . . . . . \nosubgrouping . . . . . . . . . . . . . . . . . . . . . . . . \overload [(function declaration)] . . . . . . . . . . . . . . \package . . . . . . . . . . . . . . . . . . . . . . \page (title) . . . . . . . . . . . . . . . . . . . . \private . . . . . . . . . . . . . . . . . . . . . . . . . . . . \property (qualied property name) . . . . . . . . . . . . . \protected . . . . . . . . . . . . . . . . . . . . . . . . . . . \protocol [] [] . . . \public . . . . . . . . . . . . . . . . . . . . . . . . . . . . \relates . . . . . . . . . . . . . . . . . . . . . . . \relatesalso . . . . . . . . . . . . . . . . . . . . . \showinitializer . . . . . . . . . . . . . . . . . . . . . . . . \struct [] [] . . . . \typedef (typedef declaration) . . . . . . . . . . . . . . . . \union [] [] . . . . \var (variable declaration) . . . . . . . . . . . . . . . . . . \weakgroup [(title)] . . . . . . . . . . . . . . . . \attention { attention text } . . . . . . . . . . . . . . . . . . \author { list of authors } . . . . . . . . . . . . . . . . . . \brief {brief description} . . . . . . . . . . . . . . . . . . . \bug { bug description } . . . . . . . . . . . . . . . . . . . \cond [] . . . . . . . . . . . . . . . . . . . \date { date description } . . . . . . . . . . . . . . . . . . . \deprecated { description } . . . . . . . . . . . . . . . . . . \details {detailed decription} . . . . . . . . . . . . . . . . \else . . . . . . . . . . . . . . . . . . . . . . . . . . . . . \elseif . . . . . . . . . . . . . . . . . . . \endcond . . . . . . . . . . . . . . . . . . . . . . . . . . . \endif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . \exception { exception description } . \if . . . . . . . . . . . . . . . . . . . . . . \ifnot . . . . . . . . . . . . . . . . . . . . \invariant { description of invariant } . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .