Doxygen-配置选项【二】

Doxygen配置选项

Doxygen-配置选项【一】

Build

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

  • EXTRACT_ALL——记录文档中的所有实体,私有类成员和静态文件成员将会隐藏,除非EXTRACT_PRIVATE和EXTRACT_STATIC分别设为”YES”,默认”NO”,”YES”启用

Doxygen-配置选项【二】

Doxygen-配置选项【二】

  • EXTRACT_PRIVATE——在文档中包含类的所有私有成员,默认”NO”,”YES”启用

Doxygen-配置选项【二】

  • EXTRACT_STATIC——在文档中包含文件内的所有静态成员,默认”NO”,”YES”启用
  • CASE_SENSE_NAMES——文件名区分大小写,Windows(包括Cygwin)和MacOS中应设为”NO”,Linux或其它Unix系统应设为”YES”,默认取决于系统
  • HIDE_SCOPE_NAMES——隐藏成员的完整类和命名空间范围,默认”NO”,”YES”启用

Doxygen-配置选项【二】

  • HIDE_COMPOUND_REFERENCE——隐藏页面标题的复合参考,默认”NO”,”YES”启用

Doxygen-配置选项【二】

  • SHOW_HEADERFILE——在类文档中展示使用该类需要包含的文件,默认”YES”,”NO”关闭

Doxygen-配置选项【二】

  • SHOW_INCLUDE_FILES——在文件中添加该文件包含的其它文件,默认”YES”,”NO”关闭

Doxygen-配置选项【二】

  • SHOW_USED_FILES——在类和结构文档的下方展示用于生成该文档的文件,默认”YES”,”NO”关闭

Doxygen-配置选项【二】

  • SHOW_FILES——在快速索引和文件夹树视图(若启用)中展示文件条目,默认”YES”,”NO”关闭

Doxygen-配置选项【二】

  • SHOW_NAMESPACES——在快速索引和文件夹树视图(若启用)中展示命名空间条目,默认”YES”,”NO”关闭
  • LAYOUT_FILE——布局文件,参见Doxygen-风格样式【一】

其它的配置项有(同Doxygen配置顺序):

  • EXTRACT_PRIV_VIRTUAL
  • EXTRACT_PACKAGE
  • EXTRACT_LOCAL_CLASSES
  • EXTRACT_LOCAL_METHODS
  • EXTRACT_ANON_NSPACES
  • RESOLVE_UNNAMED_PARAMS
  • HIDE_UNDOC_MEMBERS
  • HIDE_UNDOC_CLASSES
  • HIDE_FRIEND_COMPOUNDS
  • HIDE_IN_BODY_DOCS
  • INTERNAL_DOCS
  • SHOW_GROUPED_MEMB_INC
  • FORCE_LOCAL_INCLUDES
  • INLINE_INFO
  • SORT_MEMBER_DOCS
  • SORT_BRIEF_DOCS
  • SORT_MEMBERS_CTORS_1ST
  • SORT_GROUP_NAMES
  • SORT_BY_SCOPE_NAME
  • STRICT_PROTO_MATCHING
  • GENERATE_TODOLIST
  • GENERATE_TESTLIST
  • GENERATE_BUGLIST
  • GENERATE_DEPRECATEDLIST
  • ENABLED_SECTIONS
  • MAX_INITIALIZER_LINES
  • FILE_VERSION_FILTER
  • CITE_BIB_FILES

Index

  • ALPHABETICAL_INDEX——生成类字母表索引页,默认”YES”,”NO”关闭

Doxygen-配置选项【二】

  • IGNORE_PREFIX——指定生成索引时类名中需要忽略的前缀,该项需要ALPHABETICAL_INDEX设为”YES”,默认留空

Doxygen-配置选项【二】

原文始发于微信公众号(技术知识小记):Doxygen-配置选项【二】

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/184997.html

(0)
小半的头像小半

相关推荐

发表回复

登录后才能评论
极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!