Doxygen配置选项

HTML

下面是一些HTML中常用的配置项及设置效果

GENERATE_HTML——生成HTML输出，默认”YES”，”NO”关闭
HTML_OUTPUT——指定HTML文档输出目录，使用相对路径时，HTML文档输出目录将位于Project-OUTPUT_DIRECTORY指定的目录中，默认”html”
HTML_FILE_EXTENSION——指定所有生成的HTML页面的文件扩展名（如，.htm，.php，.asp），默认”.html”
HTML_HEADER——为所有生成的HTML页面指定自定义的HTML页眉文件，留空时生成标准页眉，默认留空，建议使用doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile生成默认的页眉，然后修改new_header.html，需注意更新到新版本Doxygen时页眉会跟随改变，因此需要重新生成默认页眉，参见Doxygen-风格样式【二】
HTML_FOOTER——为所有生成的HTML页面指定自定义的HTML页脚文件，留空时生成标准页脚，默认留空，参见Doxygen-风格样式【二】
HTML_STYLESHEET——指定用于所有HTML页面的自定义CSS文件，可以用于微调HTML输出效果，留空时生成默认样式表，默认留空，需注意该配置项未来将废弃，建议使用鲁棒性更好的HTML_EXTRA_STYLESHEET替代该配置项，参见Doxygen-风格样式【二】
HTML_EXTRA_STYLESHEET——指定在Doxygen创建的标准样式表后包含的附加自定义CSS文件，使用该选项可以覆盖某些样式外观，Doxygen会将样式表文件复制到输出目录中，需注意附加样式表文件的顺序很重要（即，附加样式表列表中的最后一个样式表会覆盖前面的样式表的设置），默认留空，参见Doxygen-风格样式【二】
HTML_COLORSTYLE_HUE——HTML输出色调调节，0-359，默认220，参见Doxygen-风格样式【二】
HTML_COLORSTYLE_SAT——HTML输出饱和度调节，0-255，默认100，参见Doxygen-风格样式【二】
HTML_COLORSTYLE_GAMMA——HTML输出明度调节，40-240，默认80，参见Doxygen-风格样式【二】
HTML_TIMESTAMP——所有HTML页面的页脚在生成时包含日期和时间，默认”NO”，”YES”启用

HTML_DYNAMIC_MENUS——生成的HTML文档主索引具有垂直导航菜单，垂直导航菜单通过JavaScript动态创建，设为”NO”则导航索引由静态嵌入在每个HTML页面的多级表格组成，默认”YES”，”NO”关闭

DISABLE_INDEX——禁用HTML页面上方的水平导航栏（索引），默认”NO”，”YES”启用，参见Doxygen-风格样式【一】

GENERATE_TREEVIEW——控制是否生成树视图导航栏，需要浏览器支持JavaScript、DHTML、CSS及其它需求的框架，默认”NO”，”YES”启用，参见Doxygen-风格样式【一】

FULL_SIDEBAR——GENERATE_TREEVIEW和DISABLE_INDEX都设为”YES”时，确定侧边栏仅包含树视图区域（”NO”）还是扩展到整个窗口的高度（项目logo、标题、描述均在侧边栏中展示）（”YES”），默认”NO”，参见Doxygen-风格样式【一】

TREEVIEW_WIDTH——设置树视图展示时的初始宽度（像素），0-1500，默认250
SEARCHENGINE——在HTML输出中生成搜索框，基础搜索引擎使用JavaScript和DHTML。需注意使用HTML help(GENERATE_HTMLHELP)，Qt help (GENERATE_QHP)，或docsets (GENERATE_DOCSET)时已经包含了搜索功能，因此该配置项应关闭。对于大工程，基于JavaScript的搜索引擎可能较慢，启用SERVER_BASED_SEARCH可能提供更好的处理。支持使用键盘进行搜索操作，使用<access key> + S跳转到搜索框（<access key>取决于操作系统和浏览器，通常是<CTRL>，<ALT>/<option>，或两者）。搜索框中使用<cursor down key>来跳转到搜索结果窗口，结果可以通过<cursor keys>导航。按下<Enter>选择结果项或<escape>取消搜索。光标位于搜索框中时可以通过按下<Shift>+<cursor down>来选择过滤器选项，此时使用<cursor keys>选择过滤器，<Enter>或<escape>启用或取消过滤器选项。默认”YES”，”NO”关闭