doxygen筆記
Doxygen是一個自動生成文檔的工具,支持C、C++、Java、Objective-C和IDL語言。只要在代碼註釋時遵循指定規則,就可以用該工具自動生成說明文檔。可生成的文檔格式包括HTML、XML、LaTeX、RTF、Unix Man Page,而其中還可衍生出不少其它格式。HTML可以打包成CHM格式,而LaTeX可以透過一些工具產生出PS或是PDF文檔。
1.安裝
Graphviz:http://www.graphviz.org/download/
doxygen: http://sourceforge.net/projects/doxygen/
doxygen直接安裝,主要使用doxywizard,而Graphviz的bin目錄加入到系統環境path
2.使用
簡單示例:(推薦b站)
https://www.bilibili.com/video/BV1ZE411F7kW?p=5
https://www.cnblogs.com/tianzhijiexian/p/4392924.htm
常用的命令:
doxygen增加圖片:
doxywizard生成添加屬性 IMAGE_PATH = ./doc/images 相對工程目錄
代碼加入:@image 圖片路徑(性對於IMAGE_PATH )
比如@image opencv-orb.png
簡單運行結果:(以ORBSLAM2代碼爲例)