前段時間公司裡做項目要求遵循doxygen文檔規范,並且在Windows XP下安裝了Doxygen 1.8.4版本,使用起來能查看頭文件是否遵循doxygen規范和一些簡單的錯誤,另外還可以根據C或者C++源代碼生成對應的API文檔,尤其是生成html格式的話就更方便了。
比如說想查找dbus、glib等源代碼的相關API文檔,可以使用doxygen工具將下載的開源軟件的源代碼生成對應的API文檔。
doxygen也有linux的開源版本,下載地址如下:http://sourceforge.net/projects/doxygen/
doxygen的網址:http://www.stack.nl/~dimitri/doxygen/index.html
http://www.doxygen.org/
關於doxygen的介紹:
Doxygen是一種開源跨平台的,以類似JavaDoc風格描述的文檔系統,完全支持C、C++、Java、Objective-C和IDL語言,部分支持PHP、C#。注釋的語法與Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以從一套歸檔源文件開始,生成HTML格式的在線類浏覽器,或離線的LATEX、RTF參考手冊。
一、在Ubuntu12.04下使用apt-get install命令即可安裝doxygen命令行工具和相應的GUI工具,命令如下:
sudo apt-get install doxygen
sudo apt-get install doxygen-gui
安裝之後在/usr/bin目錄下有關於doxygen的三個命令工具:
doxygen(命令行工具)
doxytag
doxywizard(GUI向導工具)
二、在Ubuntu12.04下使用doxygen將下載好的源代碼生成API文檔。
1、以從blfs網站下載源代碼D-Bus-1.6.10,鏈接為:http://dbus.freedesktop.org/releases/dbus/dbus-1.6.10.tar.gz,這個網站有很多現成的linux常用軟件。
2、Ctrl+Alt+T打開終端,輸入doxywizard,會彈出如下的doxygen GUI界面,這個使用起來和Windows XP下使用的doxygen差不多。
2、將剛下載的dbus-1.6.10.tar.gz解壓縮
進入dbus-1.6.10.tar.gz下載所在目錄,使用如下命令解壓:
tar -xzvf dbus-1.6.10.tar.gz
或者選擇dbus-1.6.10.tar.gz點擊右鍵,選擇【Extract here】即可。
3、配置dbus工程的選項,例如:doxygen腳本配置文件存放路徑、doxygen API文檔存放路徑、工程名、版本號等信息。
在工作目錄,例如/home/ccf/Downloads下創建tmp目錄存放doxygen腳本配置文件,創建dbus-html-docs目錄用於存放輸出的dbus API文檔,另外將解壓縮後的dbus-1.6.10源代碼也移動到此目錄下,在第1步彈出的doxygen gui界面中進行如下配置:
從上面的配置可以看出:
doxygen API配置腳本存放路徑為:/home/ccf/Downloads/tmp
工程名稱為:dbus
版本號為:1.6.10
源代碼所在目錄為:/home/ccf/Downloads/dbus-1.6.10
doxygen API文檔輸出路徑:/home/ccf/Downloads/dbus-html-docs
另外,注意上面的【Scan recursively】單選框一定要選上,否則生成不了對應的doxygen API文檔。