如何使用Doxygen生成keil工程的代碼文檔 (how to use doxygen properly with keil)

書接上文，Doxygen生成美麗註釋文檔（1）：初體驗，

已經體驗過使用Doxygen，以註釋的方式，同時生成代碼文檔。

那麼對於使用Keil開發單片機程序的話，是否能夠集成到Keil軟件中使用Doxygen呢。

 

經過查看ARM官網，找到了相應的方法，以下圖所示。（小知識：2011年，Keil軟件公司被ARM公司收購，Keil公司資產總額爲450萬美圓。）

具體方式以下：

1. 安裝Doxygen和graphviz（見前文博客）

2. 打開Keil的 Tool -> Customize Tools Menu...

3. 添加一個名爲 Doxygen : Make Template 的工具欄實體。在此項目中：

　　* Command : 填寫doxygen.exe程序的絕對路徑名稱

　　* Arguments: 填寫 -g @p.doxyfile

4. 添加一個名爲 Doxygen : Generate Documentation 的工具欄實體。在此項目中：

　　* Command: 填寫doxygen.exe程序的絕對路徑名稱

　　* Arguments: 填寫 @p.doxyfile

步驟3中 -g 是生成doxyfile文檔，同doxygen的命令行中幫助內容的1)，@p 指代工程名稱 ，@p.xxxx 後綴名能夠任意內容，可是要保持兩個工具欄實體的配置文件名稱相同。

步驟4中 Arguments 爲 @p.doxyfile 表示使用配置文件，生成代碼文檔，同doxygen命令行中幫助內容的3)。

C:\Users>doxygen /? # 幫助 error: configuration file /? not found! Doxygen version 1.8.14 Copyright Dimitri van Heesch 1997-2015 You can use doxygen in a number of ways: 1) Use doxygen to generate a template configuration file: doxygen [-s] -g [configName] # 生成配置文件  If - is used for configName doxygen will write to standard output. 2) Use doxygen to update an old configuration file: doxygen [-s] -u [configName] 3) Use doxygen to generate documentation using an existing configuration file: doxygen [configName] # 依據配置文件，生成文檔 If - is used for configName doxygen will read from standard input. 4) Use doxygen to generate a template file controlling the layout of the generated documentation: doxygen -l [layoutFileName.xml] 5) Use doxygen to generate a template style sheet file for RTF, HTML or Latex. RTF: doxygen -w rtf styleSheetFile HTML: doxygen -w html headerFile footerFile styleSheetFile [configFile] LaTeX: doxygen -w latex headerFile footerFile styleSheetFile [configFile] 6) Use doxygen to generate a rtf extensions file RTF: doxygen -e rtf extensionsFile If -s is specified the comments of the configuration items in the config file will be omitted. If configName is omitted `Doxyfile' will be used as a default. -v print version string C:\Users>

上述2,3,4步驟操做以下圖：

 

 

 使用演示以下：

1.  打開一個工程

2. 使用 Tools - Doxygen: Make Template 生成一個配置文件，文件生成路徑爲uv5文件的路徑，名稱是工程名稱，後綴是.doxyfile

3. 添加這個配置文件 projectName.doxyfile 到工程項目中，打開文件，按照 官網的配置文件說明 配置相關參數。

4. 使用 Tools - Doxygen: Make Documetation 生成文檔。

 

參考文獻

[1]. ARM Information Center

[2]. Doxygen Manual: Configuration