doxygen 使用

這文值得一看:

http://www.doc88.com/p-38771914275.html

http://www.cnblogs.com/xuxm2007/archive/2010/11/05/1870108.html

1、export設置:

doxygen -g xx.cfg

根據下邊3條修改配置文件xx.cfg,然後執行 doxygen xx.cfg,就會得到相應文件在project->OUTPUT_DIRECTORY下

 1) 常規

project->PROJECT_NAME=XX   工程名

project->OUTPUT_DIRECTORY=doc 輸出目錄

input->INPUT=D:\SRC\  輸入文件或目錄

input->RECURSIVE=YES 遞歸目錄輸入

input->EXCLUDE=D:\SRC\XX\BIN\ D:\SRC\XX\TEST\ 排除輸入目錄或文件

input->EXCLUDE_PATTERNS=*/.svn/* */Debug/* */Release/* 排除模式匹配

build->GENERATE_TODOLIST=NO

build->GENERATE_LATEX=NO

2)中文顯示問題

 project->DOXYFILE_ENCODING=GB2312

 project->OUTPUT_LANGUAGE=Chinese 

 input->INPUT_ENCODING=GBK2312

 3)Dot

 Dot->HAVE_DOT

 Dot-> UML_LOOK

 Dot->CALL_GRAPH

 Dot->CALLER_GRAPH 

2、對於中文編碼設置後還是亂碼的情況,請保證源程序文件是否是ANSI編碼(即GB2312/GBK),如不是請轉下,我這邊是用的notepad.exe程序另存爲修改的。還可以用VS修改。如果轉了還是不行,估計是文件壞了,可以重新做這個文件,或把這個文件通過input->EXCLUDE排除(要用絕對路徑)。

3、我使用的註釋

多行註釋

/*! \file test.h

 *  \brief  test

 *  詳細信息

*/

單行

/// 代碼段說明

/*! 代碼行說明 */

///< 單行右側註釋

4、命令

\file

\fn

\enum

\struct

\param

\return

\var

\brief

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章