Doxygen - Source Code Documentation Generator Tool
-
Upload
guo-albert -
Category
Business
-
view
6.999 -
download
2
description
Transcript of Doxygen - Source Code Documentation Generator Tool
![Page 1: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/1.jpg)
Doxygen – Source Code Documentation Generator ToolAlbert Guo
![Page 2: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/2.jpg)
Agenda
• What is Doxygen
• Doxygen Features
• Getting Start
• Check the result
![Page 3: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/3.jpg)
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
![Page 4: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/4.jpg)
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
![Page 5: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/5.jpg)
Getting Start
![Page 6: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/6.jpg)
Getting Start – cont.
Click Wizard buttonClick Wizard button
![Page 7: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/7.jpg)
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
![Page 8: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/8.jpg)
Getting Start – cont.
Scan all entitiesScan all entities
Select your languageSelect your language
![Page 9: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/9.jpg)
Getting Start – cont.
Select your output formatSelect your output format
![Page 10: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/10.jpg)
Getting Start – cont.
Assign the diagram you want to generateAssign the diagram you want to generate
![Page 11: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/11.jpg)
Getting Start – cont.
Save doxygen config fileSave doxygen config file
![Page 12: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/12.jpg)
Getting Start – cont.
Assign Doxygen working directoryAssign Doxygen working directory
![Page 13: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/13.jpg)
Getting Start – cont.
Click Start to start document generationClick Start to start document generation
![Page 14: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/14.jpg)
Getting Start – cont.
Generation finishedGeneration finished
![Page 15: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/15.jpg)
Check the result
Class hierarchyClass hierarchy
UML DiagramUML Diagram
![Page 16: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/16.jpg)
Check the result – cont.
![Page 17: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/17.jpg)
Check the result – cont.
![Page 18: Doxygen - Source Code Documentation Generator Tool](https://reader033.fdocuments.net/reader033/viewer/2022061201/547930e95906b58f048b468d/html5/thumbnails/18.jpg)
Check the result – cont.