Doxygen - Source Code Documentation Generator Tool

5,132 views

Published on

Published in: Business, Technology
0 Comments
3 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
5,132
On SlideShare
0
From Embeds
0
Number of Embeds
30
Actions
Shares
0
Downloads
96
Comments
0
Likes
3
Embeds 0
No embeds

No notes for slide

Doxygen - Source Code Documentation Generator Tool

  1. 1. Doxygen – Source Code Documentation Generator Tool Albert Guo [email_address]
  2. 2. Agenda <ul><li>What is Doxygen </li></ul><ul><li>Doxygen Features </li></ul><ul><li>Getting Start </li></ul><ul><li>Check the result </li></ul>
  3. 3. What is Doxygen <ul><li>Doxygen is source code documentation generator tool </li></ul><ul><li>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. </li></ul><ul><li>Official Site: http://www.stack.nl/~dimitri/doxygen/index.html </li></ul><ul><li>You can go to here, http://www.stack.nl/~dimitri/doxygen/manual.html , to get further information </li></ul>
  4. 4. Doxygen Features <ul><li>Can extract the code structure from undocumented source files. </li></ul><ul><li>Shows relations between the various elements (functions, typedefs, structs, etc.) as hyperlinks </li></ul><ul><li>Can generate inheritance diagrams and other diagrams </li></ul>
  5. 5. Getting Start
  6. 6. Getting Start – cont. Click Wizard button
  7. 7. Getting Start – cont. Assign Project Name Assign your source repository, and check the scan recursively checkbox Assign the document generation destination
  8. 8. Getting Start – cont. Scan all entities Select your language
  9. 9. Getting Start – cont. Select your output format
  10. 10. Getting Start – cont. Assign the diagram you want to generate
  11. 11. Getting Start – cont. Save doxygen config file
  12. 12. Getting Start – cont. Assign Doxygen working directory
  13. 13. Getting Start – cont. Click Start to start document generation
  14. 14. Getting Start – cont. Generation finished
  15. 15. Check the result Class hierarchy UML Diagram
  16. 16. Check the result – cont.
  17. 17. Check the result – cont.
  18. 18. Check the result – cont.

×