Professor

Manual for version 1.8.2 Written by Dimitri van Heesch ©1997-2012

Contents

I
1 1.1 1.2 1.3 1.4 1.5 1.6 2 2.1 2.2 2.3

User Manual
Installation Compiling from source on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing the binaries on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Known compilation problems forUNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5
7 7 8 9 11 11 12 13 14 14 15 15 16 16 16 16 16 19 19 19 21 22 24 26 27 28 28 30

Compiling from source on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing the binaries on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Tools used to develop doxygen .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Getting Started Step 0: Check if doxygen supports your programming language . . . . . . . . . . . . . . . . . . . . Step 1: Creating a configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 2: Running doxygen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.3.1 2.3.2 2.3.3 2.3.4 2.3.5 HTML output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

LaTeX output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTF output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

XML output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . Man page output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2.4 3 3.1

Step 3: Documenting the sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Documenting the code Special comment blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.1.1 Comment blocks for C-likelanguages (C/C++/C#/Objective-C/PHP/Java) . . . . . . . . . . . 3.1.1.1 3.1.1.2 3.1.1.3 3.1.2 3.1.3 3.1.4 3.1.5 Putting documentation after members . . . . . . . . . . . . . . . . . . . . . . . Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Documentation at other places

Comment blocks in Python . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . Comment blocks in VHDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Comment blocks in Fortran . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Comment blocks in Tcl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

3.2

Anatomy of a comment block . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . .

4

CONTENTS

4 4.1

Markdown Standard Markdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.1 4.1.2 4.1.3 4.1.4 4.1.5 4.1.6 4.1.7 4.1.8 4.1.9 Paragraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Headers . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . Block quotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Code Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Horizontal Rulers . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . Emphasis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . code spans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.9.1 4.1.9.2 4.1.10 Images Inline Links . . . . . . . . ....