Doxygen - Source Code Documentation Generator Tool
Download as PPT, PDF3 likes2,363 views
Doxygen is a documentation generator tool that can extract code structure and documentation from source files written in C, C++, Java, Python and other languages. It shows relations between code elements like functions and classes through hyperlinks. Doxygen can generate documentation websites, inheritance diagrams and other diagrams. To use it, the user runs the Doxygen wizard, specifies the source code and output locations, selects diagrams to generate, and clicks start to generate documentation. The results can then be viewed through automatically generated class hierarchy diagrams, UML diagrams and other documentation.
![Doxygen – Source Code Documentation Generator Tool Albert Guo [email_address]](https://image.slidesharecdn.com/doxygen-source-code-documentation-generator-tool-1213950240815536-9/85/Doxygen-Source-Code-Documentation-Generator-Tool-1-320.jpg)
Doxygen - Source Code Documentation Generator Tool
- 1. Doxygen – Source Code Documentation Generator Tool Albert Guo [email_address]
- 2. Agenda What is Doxygen Doxygen Features Getting Start Check the result
- 3. 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
- 4. 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
- 6. Getting Start – cont. Click Wizard button
- 7. Getting Start – cont. Assign Project Name Assign your source repository, and check the scan recursively checkbox Assign the document generation destination
- 8. Getting Start – cont. Scan all entities Select your language
- 9. Getting Start – cont. Select your output format
- 10. Getting Start – cont. Assign the diagram you want to generate
- 11. Getting Start – cont. Save doxygen config file
- 12. Getting Start – cont. Assign Doxygen working directory
- 13. Getting Start – cont. Click Start to start document generation
- 14. Getting Start – cont. Generation finished
- 15. Check the result Class hierarchy UML Diagram
- 16. Check the result – cont.
- 17. Check the result – cont.
- 18. Check the result – cont.