Doxygen c++接口文檔,生成pdf

注:本文不介紹代碼接口注釋寫法。

DoxyWizard

我使用的是windows下的doxyWizard,界面如下所示:

image.png

step1

選擇Doxygen工作目錄。此處我直接選擇工程目錄,這樣會在工程目錄下生成一個doxyfile,以后再使用doxygen為此工程創(chuàng)建接口文檔時,可以直接使用doxyWizard打開工程目錄下的doxyfile恢復相關的設置。
總之是為了將這個Doxygen設置作為項目一部分,方便以后使用。

step2

  1. 根據(jù)界面提示設置好源文件的目錄,以及接口文檔的生成目錄。如果只想為接口代碼生成接口文檔,建議將接口代碼放到單獨目錄里,再將其設置為源文件的目錄。
  2. 其他保持默認,直接進入到Expert標簽下:


    1 設置語言和編碼

2 設置導出選項

只有設置上面Extract_all這個選項才能識別如下的全局using語句

using LaneInfoSConstPtr = std::shared_ptr<const cicv::hdmap::LaneInfoS >;

3 HTML樹狀導航

設置以上選項,HTML會生成側邊的樹狀導航欄。

  1. 完成以上選項,切換到Run標簽欄,點擊Run doxygen,完事兒。

Doxygen主頁內容設置

打開生成的html文件,會發(fā)現(xiàn)主頁大片空白沒有內容。


主頁

如上圖所示,如果主頁空白部分能有基本的使用說明最好不過了。
為主頁添加內容也很簡單,打開一個接口代碼文檔,加入以下注釋:

/*! \mainpage 主頁
# 簡介
一些描述。
# Quick Start
一些使用說明。
 */

可以看出,我們注釋的內容使用了MarkDown的語法。
然后重新生成接口文檔,再打開看一下:


主頁

可以看到,主頁有內容了。

生成pdf

有時項目中仍然需要提交word或者pdf的文檔,所以還需要生成一份pdf格式的接口文檔。
這里使用的工具是 MikTex ,安裝參考:
https://blog.csdn.net/Yonggie/article/details/97965554
安裝好之后,將安裝目錄下的bin目錄添加到環(huán)境變量path里面去!比如我的安裝目錄:
D:\Program Files\MiKTeX\miktex\bin\x64,這個目錄下面有一個pdflatex.exe的可執(zhí)行程序,它就相當于編譯器!

然后進入接口文檔生成目錄latex目錄下。你會發(fā)現(xiàn)整個目錄下面有一個makefile文件,是不是知道該怎么做了。感興趣可以打開makefile文件看一下,實際上就是用pdflatex.exe去編譯latex目錄下面的文件。
在此目錄下打開命令行終端(cmd),直接輸入make命令,會在該目錄下編譯生成pdf文件。

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

友情鏈接更多精彩內容