how to generate doxygen documents

15
How to generate Doxygen documents Author: [email protected] Date: 2015/03/26

Upload: chih-hansteven-lin

Post on 21-Jul-2015

88 views

Category:

Software


4 download

TRANSCRIPT

Page 1: How to generate doxygen documents

How to generate Doxygen documentsAuthor: [email protected]: 2015/03/26

Page 2: How to generate doxygen documents

Download and install Doxygen

• Downlaod and install Doxygen:http://www.stack.nl/~dimitri/doxygen/download.html

• Make sure command line tool doxygen can be found:

Page 3: How to generate doxygen documents

Download and install Graphviz

• For most diagrams the dot tool of the GraphViz package is needed, download and install it:http://www.graphviz.org/

• Add C:\Program Files (x86)\Graphviz2.38\bin to your $PATH

• Make sure command line tool dot can be found:

Page 4: How to generate doxygen documents

Use Doxygen GUI frontend

• Ref: http://www.stack.nl/~dimitri/doxygen/manual/doxywizard_usage.html

• Start the wizard:

Page 5: How to generate doxygen documents

Use Doxygen GUI frontend

Page 6: How to generate doxygen documents

Use Doxygen GUI frontend

Page 7: How to generate doxygen documents

Use Doxygen GUI frontend

Page 8: How to generate doxygen documents

Use Doxygen GUI frontend

Page 9: How to generate doxygen documents

Use Doxygen GUI frontend• You can select several input/exclude folders, encoding, file

patterns to scan in Expert->Input tab:

Page 10: How to generate doxygen documents

Use Doxygen GUI frontend• You can select what to build in Expert->Build tab:

Page 11: How to generate doxygen documents

Use Doxygen GUI frontend• Ready to Run:

Page 12: How to generate doxygen documents

Use Doxygen GUI frontend• Running: (According to your setting the running time differ)

Page 13: How to generate doxygen documents

Use Doxygen GUI frontend• Run finished:

Page 14: How to generate doxygen documents

Use Doxygen GUI frontend• Click “Show HTML output” in Run tab or open

C:\ws\project001\doxygen_project001\html\index.html:

Page 15: How to generate doxygen documents

Done