Doxygen 为html输出条件化文本
将文本(而不是代码)条件化的最佳方式是什么。 我希望将三个级别的文档条件化并标记为: Developer–这将是我根本不希望doxygen输出的文档。比如给开发者的注释。 内部–信息仅对内部版本的文档可见。Doxygen 为html输出条件化文本,doxygen,Doxygen,将文本(而不是代码)条件化的最佳方式是什么。 我希望将三个级别的文档条件化并标记为: Developer–这将是我根本不希望doxygen输出的文档。比如给开发者的注释。 内部–信息仅对内部版本的文档可见。 NDA-为客户提供的信息,以及任何未标记为开发商或内部的信息;内部文档的子集,可以过滤出内部网站。有许多doxygen命令和配置选项可以帮助您实现这一点。这些包括和\endinternal。从doxygen手册: \internal此命令启动仅供内部使用的文档片段 您可以在配置文件中使用IN
NDA-为客户提供的信息,以及任何未标记为开发商或内部的信息;内部文档的子集,可以过滤出内部网站。有许多doxygen命令和配置选项可以帮助您实现这一点。这些包括和
\endinternal
。从doxygen手册:
\internal
此命令启动仅供内部使用的文档片段
您可以在配置文件中使用INTERNAL\u DOCS
来显示(YES
)或隐藏(NO
)内部文档
要解决所需文档的三个版本,请执行以下操作:
- 开发者:使用标准C/C++注释,
/**/代码>。这些不会被强氧剂触及
- 内部:对于仅供内部使用的文档,请使用doxygen注释,
,并使用/***/
和\internal
命令包装文档的这些部分。在内部分发文档时,在生成文档时,将配置文件选项\endinternal
设置为INTERNAL_DOCS
YES
- NDA:对于客户可见的文档,只需使用doxygen注释
/***/编码>并在生成文档时将配置文件中的配置选项
设置为INTERNAL_DOCS
NO