doxygen

下载doxygen-1.8.15-setup.exe,、htmlhelp.exe、graphviz-2.38.msi、CTex-2.9.2.164.exe，并安装

 

mode - all entities - optimize for c++ output

output - html - prepare for compressed html (.chm) - with search function

output - latex

diagrams - use dot tool from diagram generator，下面六个复选框全选

 

expert - project - output_language = chinese

build - 选中 

extract_all

extract_private

extract_package

extract_static

extract_local_classes

extract_local_methods

expert - input - input_encoding = GB2312

expert - html - hhc_location = D:/Program Files (x86)/HTML Help Workshop/hhc.exe

expert - dot - dot_path = D:\Program Files (x86)\Graphviz2.38\bin

graphviz是生成类图的，如果生成类图失败，把dot路径加到环境变量中去，如果还是失败，重启电脑。

生成CHM文件 html/index.chm

pdf暂时生成失败

 

visual assist option - suggestions - edit va snippets - new va snippet

doxygen_head

/**
 * @file       $FILE_BASE$.$FILE_EXT$
 * @brief      this is brief description
 * @author     dujiang
 * @version    1.0.0.1
 * @date       $DATE$
 */

doxygen_class.

/** 
 * @brief	this is class description
 */

doxygen_function

/**
 *  @brief  Thisis a brief description.
 *  @param[in]  inArgName input argument description.type name:purpose(Range)
 *  @param[out] outArgName output argument description.
 *  @return:    description of the return value  
 */