【问题标题】:How do I tell doxygen a function is "self-documenting"?我如何告诉 doxygen 一个函数是“自我记录”的?
【发布时间】:2019-05-15 10:36:05
【问题描述】:

我在我的 (C++) 项目中使用 Doxygen。

我有一些不言自明的功能,我不想添加任何评论或解释 - 但我确实希望作为文档的一部分出现。现在,如果我不编写 /** */ 块,这确实会作为 doxygen 的默认行为发生,但是 - 我在 Doxygen 的输出中收到警告:

warning: Member foo() of namespace bar is not documented.

我如何告诉 doxygen 没有此类功能的文档也没关系?

附加信息:

  • 我有EXTRACT_ALL = NO
  • 我在 Devuan ASCII (~= Debian Stretch) 上使用 Doxygen 1.8.13

【问题讨论】:

  • 在你的 doxygen 配置文件中,EXTRACT_ALL 设置的参数是什么?
  • 请始终指定使用的 doxygen 版本。 @P.W 可能会有一些副作用,比如额外不需要的功能。
  • @P.W:见编辑。
  • @albert:见编辑。

标签: doxygen code-documentation self-documenting-code


【解决方案1】:

Doxygen 希望查看它显示的所有功能的文档,所以无论如何你都必须做点什么。

最好有一个空命令,例如:

ALIASES = selfdocumenting=" "

所以你可以写例如:

/// @selfdocumenting
void fie2(void);

【讨论】:

  • 但这不会在文档中创建空白块吗?
  • 确实会产生一些额外的空白块。
猜你喜欢
  • 2019-03-31
  • 1970-01-01
  • 2020-07-27
  • 2011-08-09
  • 1970-01-01
  • 2018-06-18
  • 1970-01-01
  • 1970-01-01
  • 2010-11-12
相关资源
最近更新 更多