Doxygen 安裝與使用筆記

最近要做 PF_RING 的程式開發,看了 Source Code 又看看 User Guide,還是不容易懂阿,於是拿了 Doxygen 來產生 Function 的關係圖,加快看 Code 的腳步


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

參考資料

樂於分享、盡情玩耍的全端工程師。長期關注資訊安全、雲端運算與網路行銷等議題,曾獲得玉山黑客松金牌,擔任過軟體測試實習生、技術文案寫手。

發表迴響