Doxygen - Source Code Documentation Generator Tool

Doxygen – Source Code Documentation Generator Tool Albert Guo [email_address]

Agenda

What is Doxygen

Doxygen Features

Getting Start

Check the result

What is Doxygen

Doxygen is source code documentation generator tool

Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D.

Official Site: http://www.stack.nl/~dimitri/doxygen/index.html

You can go to here, http://www.stack.nl/~dimitri/doxygen/manual.html , to get further information

Doxygen Features

Can extract the code structure from undocumented source files.

Shows relations between the various elements (functions, typedefs, structs, etc.) as hyperlinks

Can generate inheritance diagrams and other diagrams

Getting Start

Getting Start – cont. Click Wizard button

Getting Start – cont. Assign Project Name Assign your source repository, and check the scan recursively checkbox Assign the document generation destination

Getting Start – cont. Scan all entities Select your language

Getting Start – cont. Select your output format

Getting Start – cont. Assign the diagram you want to generate

Getting Start – cont. Save doxygen config file

Getting Start – cont. Assign Doxygen working directory

Getting Start – cont. Click Start to start document generation

Getting Start – cont. Generation finished

Check the result Class hierarchy UML Diagram

Check the result – cont.