Doxygen wizard

Doxygen GUI fontend为Doxygen的界面操作工具。本篇为wizard项的界面翻译。

step1 :

Specify the working directory from which doxygen will run

设置doxygen的工作路径

step2 :

Configure doxygen using the Wizard and/or Expert tab, then switch to the Run tab to generate the documentation

使用Wizard和/或Expert配置doxygen，切换到Run生成文档

Wizard

Topics

Project

• Provide some information about the project you are documenting
  • Project name 项目名称
  • Project synopsis 项目概要
  • Project version or id 项目版本
  • Project logo 项目图标
• Specify the directory to scan for source code
  • Source code directory 源代码路径
  • Scan recursively 是否递归扫描
• Specify the directory where doxygen should put the generated documentation
  • Destination directory 输出路径
    

Mode

• Select the desired extraction mode 选择代码抽取模式
  • Documented entities only 仅记录的实体
  • All Entities 所有实体
  • Include cross-referenced source code in the output 在输出中包括交叉引用的源代码*
• Select programmin langguage to optimize the results for
  • C++
  • C++/CLI
  • Java or C#
  • C or PHP
  • Fortan
  • VHDL
    

Output

• Select the output format(s) to generate 选择生成的格式
  • HTML
    • plain HTML 纯HTML格式
    • with navigation panel 加入导航面板
    • prepare for compressed HTML(.chm) 添加CHM文件支持
    • With search function 增加搜索框
      • Change color 更改配色方案
  • LaTeX
    • as intermediate format for hyperlinked PDF 超链接PDF的中间格式
    • as intermediate format for PDF PDF的中间格式
    • as intermediate format for PostScript PostScript的中间格式
• Man pages 手册页
• Rich Text Format(RTF) 富文本格式
• XML
  

Diagrams

• Diagrams to generate
  • No diagrams 无图模式
  • Use built-in class diagram generator 使用Doxygen内置的图引擎
  • Use dot tool from the GraphViz package 使用GraphViz包
  • Dot graphs to generate
    • Class diagrams 类
    • Collaboration diagrams 协作关系图
    • Overall Class hierarchy 整体类层次结构
    • Include dependency graphs 包括依赖关系图
    • Included by dependency graphs 由依赖关系图包含
    • Call graphs 调用图
    • Called by graphs 由图调用