2016年3月29日 星期二

[doxygen] How to use doxygen to generate comment into document (C language)

Create configuration file was called “Doxyfile”

Method 1
Using doxygen to generate configuration file was called “Doxyfile”.
doxygen -g

Method 2
The configuration file was created by user.
Following parameter put into configuration file.

I like method 2 because it is simple and open the function which I want.

Edit the configuration file
EXTRACT_ALL = yes
EXTRACT_PRIVATE = yes
EXTRACT_STATIC = yes
#Do not add anything here unless you need to. Doxygen already covers all 
#common formats like .c/.cc/.cxx/.c++/.cpp/.inl/.h/.hpp
FILE_PATTERNS =
RECURSIVE = yes

Generating graphs and diagrams
CLASS_DIAGRAMS = yes
HAVE_DOT = yes
CLASS_GRAPH = yes
COLLABORATION_GRAPH = yes

Create HTML

Generate html file by doxygen command.

Reference:

0 意見:

張貼留言