1.安裝doxygen
目前最新版本的的doxygen是doxygen1.8.13,安裝包可以在官網上下載,網址是:http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc。
從官網下載的時候,先下載的是doxygen-1.8.13.src.tar.gz這個安裝包,發現只有這一個安裝包用不了,沒有可執行的configure文件和makefile文件,需要再下載另外一個安裝包doxygen-1.8.13.linux.bin.tar.gz。中文版Linux操作系統中下載之后默認存在“下載”文件夾中,英文版Linux操作系統中下載之后默認存在“Downloads”文件夾中。
下載完成后,打開termianal輸入指令:
(1)cd 下載
(2)tar xvfz doxygen-1.8.13.src.tar.gz
(3)tar xvfz doxygen-1.8.13.linux.bin.tar.gz
(4) cd doxygen-1.8.13
(5)./configure
(6)sudo make
(7)sudo make install
在安裝的時候會遇到一些問題,如下圖所示:
無法獲取‘bin/doxytag’的文件狀態,我們可以先看一下Makefile文件和bin文件夾,發現Makefile文件中需要用到的文件bin文件夾中並沒有。
如果想要正確安裝doxygen就要對Makefile文件進行修改。通過vim Makefile命令打開Makefile文件,根據bin文件夾中的有的文件來修改Makefile文件如下圖:
然后再用命令sudo make install安裝就可以了。
2.配置Doxygen工作環境
進入項目目錄( test 為例說明) cd test/
生成配置文件 Doxygen –g
默認生成的配置文件名為 "Doxyfile" ,也可以采用 "doxygen -g your-cfg-filename" 命令格式指定所生成的配置文件名。如無特殊需要,采用默認的配置文件名即可。
Doxyfile 文件內容非常多,大概 1000 多行,不過其中約 4/5 都是注釋,每個配置選項都有一段詳細的注釋。日后,如果對 Doxygen 各配置選項的意義有一定了解,可以在生成配置文件的命令中添加 "-s" 選項,生成不含注釋的配置文件,操作如下:
$ doxygen –s -g
3.配置文件的相應設置
接下來需要打開這個Doxygen文檔,對其中某些字段做配置,一般來說,只需要配置其中十幾個字段就可以:
# 項目名稱,將作為於所生成的程序文檔首頁標題
PROJECT_NAME = “Test“
# 文檔版本號,可對應於項目版本號,譬如 svn 、 cvs 所生成的項目版本號
PROJECT_NUMBER = "1.0.0”
# 程序文檔輸出目錄
OUTPUT_DIRECTORY = doc/
# 程序文檔語言環境
OUTPUT_LANGUAGE = Chinese
# 如果是制作 C 程序文檔,該選項必須設為 YES ,否則默認生成 C++ 文檔格式
OPTIMIZE_OUTPUT_FOR_C = YES
# 對於使用 typedef 定義的結構體、枚舉、聯合等數據類型,只按照 typedef 定義的類型名進行文檔化
TYPEDEF_HIDES_STRUCT = YES
# 在 C++ 程序文檔中,該值可以設置為 NO ,而在 C 程序文檔中,由於 C 語言沒有所謂的域 / 名字空間這樣的概念,所以此處設置為 YES
HIDE_SCOPE_NAMES = YES
# 讓 doxygen 靜悄悄地為你生成文檔,只有出現警告或錯誤時,才在終端輸出提示信息
QUIET = YES
# 只對頭文件中的文檔化信息生成程序文檔
FILE_PATTERNS = *.h
# 遞歸遍歷當前目錄的子目錄,尋找被文檔化的程序源文件
RECURSIVE = YES
# 示例程序目錄
EXAMPLE_PATH = example/
# 示例程序的頭文檔 (.h 文件 ) 與實現文檔 (.c 文件 ) 都作為程序文檔化對象
EXAMPLE_PATTERNS = *.c *.h
# 遞歸遍歷示例程序目錄的子目錄,尋找被文檔化的程序源文件
EXAMPLE_RECURSIVE = YES
# 允許程序文檔中顯示本文檔化的函數相互調用關系
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
# 不生成 latex 格式的程序文檔
GENERATE_LATEX = NO
# 在程序文檔中允許以圖例形式顯示函數調用關系,前提是你已經安裝了 graphviz 軟件包
HAVE_DOT = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
# 讓 doxygen 從配置文件所在的文件夾開始,遞歸地搜索所有的子目錄及源文件
RECURSIVE = YES
# 在最后生成的文檔中,把所有的源代碼包含在其中
SOURCE BROWSER = YES
$ 這會在 HTML 文檔中,添加一個側邊欄,並以樹狀結構顯示包、類、接口等的關系
GENERATE TREEVIEW = ALL
4.程序源碼文檔化
Doxygen的工作環境准備好之后,如果想要使用Doxygen就必須在源碼的注釋中使用Doxygen要求的注釋規則,不然Doxygen是不能識別的。
Doxygen的注釋類型可以分為:
(1)行間類型:注釋語句不與程序源碼出現在同一行,主要用於注釋頭文件中出現的結構體 (struct) 、枚舉 (enum) 、聯合 (uion) 等數據類型,以及程序接口的功能與使用約定,如下所示:
/**
* 這是Doxygen認可的行間注釋標記示例
*/
(2)行內注釋:注釋語句與程序源碼出現在同一行內,主要用於代碼的局部注釋。如下圖所示的就是Doxygen認可的行內注釋標記。
struct job{
pthread_t tid; ///線程ID
Job next; ///下一個鏈表結點
Int val; ///結點值
}
5.程序文檔生成
如果是使用“doxygen -g”生成的配置文件Doxyfile,那么在終端直接輸入doxygen就可以生成程序文檔,文檔就存放在剛剛設置的doc文件夾中。