[Doxygen] How to use doxygen to create diagram

1. Install package
   pacman -S doxygen graphviz
   
2. Goto the top directory of source code, and create doxygen configuration.
   doxygen -g a.conf
   
   
   # vim a.conf

    EXTRACT_ALL            = YES
    HAVE_DOT               = YES
    UML_LOOK               = YES

    EXTRACT_PRIVATE        = YES
    EXTRACT_STATIC         = YES
    CALL_GRAPH             = YES
    OUTPUT_DIRECTORY       = /tmp/doc/
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
    RECURSIVE              = YES

#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER         = YES

3. run doxygen to create html
doxygen a.conf

Reference:

• How to use doxygen to create UML class diagrams from C++ source
• Generating a callgraph by using Doxygen and Graphviz

Read More

[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:

• Learning doxygen for source code documentation
• Doxygen - Generate documentation from source code

Read More