如何使doxygen接受项目的无文档(但不要忽略它)

问题描述 投票:0回答:1

运行氧气时,您经常会得到很多:

warning: some-thing-or-another is not documented.

对于某些项目,您只想填写文档;但是其他的文档太琐碎了,或者我只想列出没有文档的内容。

现在,您可以使用///@cond///@endcond禁止显示这些警告,但是某些或其他内容将从文档中删除,这不是我想要的。

因此,我如何使doxygen对某些物品不发出警告,而将其保留在文档中而没有其他解释性文字?

doxygen documentation-generation code-documentation
1个回答
0
投票

深入探究技巧框。

Doxygen确实有一个命令\noop,但此命令已被滤除,因此它不被视为文档。

[有许多非打印字符,例如‍ ,因此定义如下内容:

/// \file

/** the documented fie
 */
void fie(void);

void fie1(void);

/** ‍ */
void fie2(void);

将为fie1发出警告,但不会为fiefie2发出警告。缺点是doxygen认为fie2已记录在案,因此为它创建了详细的部分。

为了克服“详细​​部分”问题,我们希望有一个命令说该功能已被记录,但不显示任何内容,也不会发出有关丢失的警告,该功能目前在doxygen中不存在。

© www.soinside.com 2019 - 2024. All rights reserved.