Doxygen中⽂使⽤
Doxygen中⽂使⽤
以下对Doxygen的使⽤分为三个部分:
⼀.⽣成基本的中⽂注释⽂档;
⼆.添加函数关系调⽤图;
三.⽣成全中⽂的chm⽂档。
⼀.⽣成基本的中⽂注释⽂档:
(⼀)  Wizard
(1)      Wizard->Project
Project name:⽣成的Doxygen注释⽂档的名称;
Project synopsis:⽣成的Doxygen注释⽂档的简介;
Project version or id:注释⽂档版本号;
Project logo:⽂档图标;
Source code directory:代码路径,也就是需要⽣成注释⽂档的代码所在的⽂件夹;
Destination directory:⽣成的注释⽂档存放的地⽅。
(2)      Wizard->Mode
若勾选上Include cross-referenced source code in output,则⽣成的Doxygen⽂档会包含相应头⽂件的源代码。(3)      Wizard->Output
plain HTML:⽣成平铺形式的页⾯;
with navigation panel:⽣成带有左侧导航栏形式的页⾯;
prepare for compressed HTML(.chm):准备⽣成chm⽂件。
(4)      Wizard->Diagrams
若不⽣成函数调⽤关系图,默认即可。
(⼆)  Expert
(1)      Expert->Project
在OUTPUT_LANGUAGE⼀栏中选择输出语⾔为Chinese。
(2)      Expert->Input
在INPUT_ENCODING⼀栏中,输⼊GB2312,这样对⽂档的注释才⽀持中⽂,否则中⽂注释将会是乱码。
在完成上诉配置后,在Run选项卡中点击Run doxygen,即可⽣成能够⽀持中⽂注释的⽂档。
⼆.填加函数关系调⽤图:
(⼀)  Expert->Dot
勾选HAVE_DOT、CALL_GRAPH、CALLER_GRAPH选项,并在DOT_PATH中添加graphviz安装⽬录下的bin⽂件夹。
(⼆)  Wizard->Project
勾选Scan recursively。
乱码文字生成(三)  Expert->Build
勾选EXTRACT_ALL、EXTRACT_PRIVATE、EXTRACT_PACKAGE、EXTRACT_STATIC、EXTRACT_LOCAL_METHODS。(四)  Wizard->Diagrams
选择Use dot tool from the GraphViz package。
三.⽣成全中⽂的chm⽂档
(⼀)  Wizard->Output
勾选prepare for compressed HTML(.chm)。
(⼆)  Expert->HTML
勾选GENERATE_HEMLHELP;
在CHM_FILE⼀栏中,填⼊⽣成的.chm⽂件的⽂件名;
在HHC_LOCATION⼀栏中,填⼊HTML Help Workshop 1.3的安装路径,选择⽂件;
在CHM_INDEX_ENCODING⼀栏中填⼊GBK。