使doxygen不接受项目的任何文档(但不要忽略它)
运行doxygen时,您通常会得到很多:使doxygen不接受项目的任何文档(但不要忽略它),doxygen,documentation-generation,code-documentation,Doxygen,Documentation Generation,Code Documentation,运行doxygen时,您通常会得到很多: warning: some-thing-or-another is not documented. 对于某些项目,您只需要填写文档;但其他的都太琐碎了,不需要文档,或者我只想列出而不需要文档 现在,您可以使用///@cond和///@endcond来抑制这些警告,但随后会从文档中删除某些东西,这不是我想要的 那么,我怎样才能让doxygen不警告我某些项目,同时将该项目保留在文档中,而不添加额外的解释文本呢?有点陷入技巧框 Doxygen确实有一个命令
warning: some-thing-or-another is not documented.
对于某些项目,您只需要填写文档;但其他的都太琐碎了,不需要文档,或者我只想列出而不需要文档
现在,您可以使用///@cond
和///@endcond
来抑制这些警告,但随后会从文档中删除某些东西,这不是我想要的
那么,我怎样才能让doxygen不警告我某些项目,同时将该项目保留在文档中,而不添加额外的解释文本呢?有点陷入技巧框 Doxygen确实有一个命令
\noop
,但它被过滤掉了,因此不被视为文档
有许多非打印字符,如&zwj
和
定义如下:
/// \file
/** the documented fie
*/
void fie(void);
void fie1(void);
/** ‍ */
void fie2(void);
将导致对fie1
发出警告,但不会对fie
和fie2
发出警告。
缺点是doxygen认为fie2
是文档化的,因此为其创建了一个详细的部分
为了克服“详细部分”的问题,我们希望有一个命令,说明该函数已被记录,但不显示任何内容,也不发出有关丢失内容的警告,这样的函数目前在doxygen中不存在