【问题标题】:Make doxygen accept no-documentation for an item (but not ignore it)使 doxygen 接受项目的无文档(但不要忽略它)
【发布时间】:2020-10-03 00:30:52
【问题描述】:
当你运行 doxygen 时,你经常会得到很多:
warning: some-thing-or-another is not documented.
对于某些项目,您只需填写文档即可;但是其他的太琐碎了,无法记录,或者我只想在没有文档的情况下列出。
现在,您可以使用 ///@cond 和 ///@endcond 抑制这些警告,但随后会从文档中删除某些东西,这不是我想要的。
那么,我怎样才能让 doxygen 不对某些项目发出警告,同时将项目保留在文档中而没有额外的解释性文字?
【问题讨论】:
标签:
doxygen
documentation-generation
code-documentation
【解决方案1】:
有点潜入技巧框。
Doxygen 确实有一个命令 \noop,但它被过滤掉了,所以它不被视为文档。
有许多非打印字符,例如 ‍ 和  ,因此定义如下:
/// \file
/** the documented fie
*/
void fie(void);
void fie1(void);
/** ‍ */
void fie2(void);
将导致fie1 发出警告,但不会导致fie 和fie2 发出警告。
缺点是 doxygen 认为 fie2 已记录在案,因此为其创建了详细的部分。
为了克服“详细部分”问题,我们希望有一个命令,说明该函数已记录但不显示任何内容并且不发出有关丢失内容的警告,这样的函数目前在 doxygen 中不存在。