Doxygen

Source code documentation generator tool

Links

公式サイト

• Doxygen http://www.doxygen.org/
• Graphviz http://www.graphviz.org/
• Option webdot
   

入門

• 設定ファイル： http://www.doxygen.jp/config.html
• コマンド： http://www.denshin8.jp/den8dev/doxygen.h​tml
   

Install

Doxygen

# wget http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.1.2.src.tar.gz 
# tar zxfv doxygen-1.8.1.2.src.tar.gz 
# cd doxygen-1.8.1.2
# ./configure
# make 
# make docs
# make install

Graphviz

# wget http://www.graphviz.org/pub/graphviz/stable/SOURCES/graphviz-2.28.0.tar.gz
# tar zxfv graphviz-2.28.0.tar.gz
# cd graphviz-2.28.0
# ./configure
# make 
# make install

Install with yum

# yum install texlive
# yum install graphviz
# yum install doxygen

コマンド

doxygen [<設定ファイル名>]

設定ファイル

# doxygen -g
# vi doxygen.conf

doxygen.conf

• PROJECT_NAME
• PROJECT_NUMBER
• PROJECT_BRIEF
• CREATE_SUBDIRS
• REPEAT_BRIEF
• ALWAYS_DETAILED_SEC
• TAB_SIZE
• TYPEDEF_HIDES_STRUCT
• EXTRACT_ALL
• EXTRACT_PRIVATE
• HIDE_SCOPE_NAMES
• SORT_BRIEF_DOCS
• SHOW_DIRECTORIES
• INPUT
• INPUT_ENCODING
• OUTPUT_DIRECTORY
• SOURCE_BROWSER
• FORMULA_FONTSIZE
• CALL_GRAPH
• CALLER_GRAPH
• HAVE_DOT
• DOT_FONTSIZE
• MAX_DOT_GRAPH_DEPTH
   

書式

@param

@return

@retval

@attention

@bug

@note

@par

@b <b></b>

@n

@code - @endcode

リスト

先頭空白

水平線

• ---
• 大見出し

@brief

@file

@author

@version

@date

@sa

• 参照

@example

• 動きません
   

X

• /**/ は使えない
• <....> は @<....>