Manual for version 1.8.3.1 Written by Dimitri van Heesch ©1997-2013 Contents I User Manual 5 1 Installation 7 1.1 Compiling from source on UNIX..................................... 7 1.2 Installing the binaries on UNIX...................................... 8 1.3 Known compilation problems for UNIX ................................. 9 1.4 Compiling from source on Windows................................... 11 1.5 Installing the binaries on Windows.................................... 11 1.6 Tools used to develop doxygen ..................................... 11 2 Getting Started 13 2.1 Step 0: Check if doxygen supports your programming language.................... 14 2.2 Step 1: Creating a configuration file................................... 14 2.3 Step 2: Running doxygen ........................................ 15 2.3.1 HTML output .......................................... 15 2.3.2 LaTeX output .......................................... 16 2.3.3 RTF output ........................................... 16 2.3.4 XML output ........................................... 16 2.3.5 Man page output ........................................ 16 2.4 Step 3: Documenting the sources.................................... 16 3 Documenting the code 19 3.1 Special comment blocks......................................... 19 3.1.1 Comment blocks for C-like languages (C/C++/C#/Objective-C/PHP/Java)........... 19 3.1.1.1 Putting documentation after members....................... 21 3.1.1.2 Examples ..................................... 22 3.1.1.3 Documentation at other places .......................... 24 3.1.2 Comment blocks in Python ................................... 26 3.1.3 Comment blocks in VHDL.................................... 27 3.1.4 Comment blocks in Fortran................................... 28 3.1.5 Comment blocks in Tcl ..................................... 28 3.2 Anatomy of a comment block ...................................... 30 4 CONTENTS 4 Markdown 31 4.1 Standard Markdown........................................... 31 4.1.1 Paragraphs ........................................... 31 4.1.2 Headers............................................. 31 4.1.3 Block quotes........................................... 32 4.1.4 Lists............................................... 32 4.1.5 Code Blocks........................................... 32 4.1.6 Horizontal Rulers ........................................ 33 4.1.7 Emphasis ............................................ 33 4.1.8 code spans ........................................... 33 4.1.9 Links............................................... 33 4.1.9.1 Inline Links..................................... 33 4.1.9.2 Reference Links.................................. 34 4.1.10 Images ............................................. 34 4.1.11 Automatic Linking........................................ 35 4.2 Markdown Extensions.......................................... 35 4.2.1 Table of Contents........................................ 35 4.2.2 Tables.............................................. 35 4.2.3 Fenced Code Blocks ...................................... 35 4.2.4 Header Id Attributes....................................... 36 4.3 Doxygen specifics............................................ 36 4.3.1 Including Markdown files as pages............................... 37 4.3.2 Treatment of HTML blocks ................................... 37 4.3.3 Code Block Indentation..................................... 37 4.3.4 Emphasis limits......................................... 38 4.3.5 Code Spans Limits ....................................... 38 4.3.6 Lists Extensions......................................... 38 4.3.7 Use of asterisks......................................... 39 4.3.8 Limits on markup scope..................................... 39 4.4 Debugging of problems ......................................... 39 5 Grouping 41 5.1 Modules ................................................. 41 5.2 Member Groups............................................. 43 5.3 Subpaging................................................ 45 6 Including Formulas 47 7 Graphs and diagrams 49 8 Preprocessing 53 Generated by Doxygen CONTENTS 5 9 Automatic link generation 57 9.1 Links to web pages and mail addresses................................. 57 9.2 Links to classes ............................................. 57 9.3 Links to files............................................... 57 9.4 Links to functions ............................................ 57 9.5 Links to other members ......................................... 58 9.6 typedefs ................................................. 60 10 Output Formats 61 11 Searching 63 12 External Indexing and Searching 67 12.1 Introduction ............................................... 67 12.2 Configuring................................................ 68 12.2.1 Single project index....................................... 69 12.2.2 Multi project index........................................ 69 12.3 Updating the index............................................ 70 12.4 Programming interface.......................................... 70 12.4.1 Indexer input format....................................... 70 12.4.2 Search URL format ....................................... 71 12.4.3 Search results format...................................... 71 13 Customizing the Output 73 13.1 Minor Tweaks .............................................. 73 13.1.1 Overall Color .......................................... 73 13.1.2 Navigation............................................ 73 13.1.3 Dynamic Content ........................................ 74 13.1.4 Header, Footer, and Stylesheet changes............................ 74 13.2 Changing the layout of pages...................................... 75 13.3 Using the XML output.......................................... 78 14 Custom Commands 79 14.1 Simple aliases.............................................. 79 14.2 Aliases with arguments ......................................... 79 14.3 Nesting custom command........................................ 80 15 Link to external documentation 81 16 Frequently Asked Questions 83 17 Troubleshooting 87 17.1 Known Problems............................................. 87 Generated by Doxygen 6 CONTENTS 17.2 How to Help ............................................... 88 17.3 How to report a bug........................................... 88 II Reference Manual 89 18 Features 91 19 Doxygen usage 93 19.1 Fine-tuning the output.......................................... 93 20 Doxywizard usage 95 21 Configuration 97 21.1 Format.................................................. 97 21.2 Project related options.......................................... 99 21.3 Build related options........................................... 102 21.4 Options related to warning and progress messages........................... 105 21.5 Input related options........................................... 106 21.6 Source browsing related options..................................... 107 21.7 Alphabetical index options........................................ 108 21.8 HTML related options .......................................... 108 21.9 LaTeX related options.......................................... 114 21.10 RTF related options ........................................... 115 21.11 Man page related options ........................................ 116 21.12 XML related options........................................... 116 21.13 AUTOGEN_DEF related options .................................... 116 21.14 PERLMOD related options........................................ 116 21.15 Preprocessor related options ...................................... 117 21.16 External reference options........................................ 117 21.17 Dot options................................................ 118 22 Special Commands 123 22.1 Introduction ............................................... 123 22.2 \addtogroup <name> [(title)] ...................................... 124 22.3 \callgraph ................................................ 125 22.4 \callergraph ............................................... 125 22.5 \category <name> [<header-file>][<header-name>] ........................ 125 22.6 \class <name> [<header-file>][<header-name>] .......................... 126 22.7 \def <name> .............................................. 126 22.8 \defgroup <name> (group title)..................................... 126 22.9 \dir [<path fragment>].......................................... 127 22.10 \enum <name> ............................................. 127 Generated by Doxygen CONTENTS 7 22.11 \example <file-name> ......................................... 127 22.12 \endinternal ............................................... 128 22.13 \extends <name> ............................................ 128 22.14 \file [<name>].............................................. 128 22.15 \fn (function declaration)......................................... 129 22.16 \headerfile <header-file> [<header-name>].............................. 129 22.17 \hideinitializer .............................................. 130 22.18 \implements <name> .......................................... 130 22.19 \ingroup (<groupname> [<groupname> <groupname>]) ...................... 130 22.20 \interface <name> [<header-file>][<header-name>] ........................ 131 22.21 \internal ................................................. 131 22.22 \mainpage [(title)] ............................................ 131 22.23 \memberof <name> ..........................................