Date post: | 28-Nov-2014 |
Category: |
Business |
Upload: | guo-albert |
View: | 6,972 times |
Download: | 2 times |
Doxygen – Source Code Documentation Generator ToolAlbert Guo
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 buttonClick Wizard button
Getting Start – cont.
Assign Project NameAssign Project Name
Assign your source repository, and check the scan recursively checkbox
Assign your source repository, and check the scan recursively checkbox
Assign the document generation destinationAssign the document generation destination
Getting Start – cont.
Scan all entitiesScan all entities
Select your languageSelect your language
Getting Start – cont.
Select your output formatSelect your output format
Getting Start – cont.
Assign the diagram you want to generateAssign the diagram you want to generate
Getting Start – cont.
Save doxygen config fileSave doxygen config file
Getting Start – cont.
Assign Doxygen working directoryAssign Doxygen working directory
Getting Start – cont.
Click Start to start document generationClick Start to start document generation
Getting Start – cont.
Generation finishedGeneration finished
Check the result
Class hierarchyClass hierarchy
UML DiagramUML Diagram
Check the result – cont.
Check the result – cont.
Check the result – cont.