最近要做PF_RING的程式開發,看了source code又看看User Guide,還是不容易懂阿QQ

於是拿了Doxygen來產生function的關係圖,加快看code的腳步XD

Doxygen安裝

$ sudo apt-get install doxygen

基本使用方式

$ doxygen -g Doxygen # 產生配置檔
$ vim Doxygen # 修改設定
$ doxygen Doxygen # 產生 doxygen document

配置檔需要修改的內容


PROJECT_NAME       = PROJECT_NAME
PROJECT_NUMBER     = 1.0
OUTPUT_DIRECTORY   = ../docs
CREATE_SUBDIRS     = YES
EXTRACT_ALL        = YES
OUTPUT_LANGUAGE    = Chinese-Traditional # default: English
FULL_PATH_NAMES    = NO # default: YES
EXTRACT_STATIC     = YES # default: NO
FILE_PATTERNS      = *.php
RECURSIVE          = YES # default: NO
REFERENCED_BY_RELATION = YES # default: NO
REFERENCES_RELATION    = YES # default: NO
INLINE_SOURCE = YES

產生圖片要再多修改三行


HAVE_DOT = YES
UML_LOOK = YES
EXTRACT_ALL = YES


參考資料

以Doxygen產生UML class diagrams

Doxygen 程式文件產生器 與 簡易筆記