如何隐藏doxygen评论的部分doxygen?

时间:2014-03-14 20:47:09

标签: doxygen

假设您有一个相当复杂的自述文件,您希望Doxygen进行处理以生成文档的主页,这与

相似。
/*! 
    \mainpage Welcome to this code

    \section S1 Introduction
    Some stuff to explain why you coded all this

    \section S2 Examples
    Many examples of how the code can be used
    !!! some line which you wouldn't write in a documentation

    \section S3 Some other stuff
*/

你希望doxygen忽略以!!!开头的行!但是你不想删除该行,因为你打算稍后编辑它。

那么,你怎么能这样做?

编辑:以下内容:

/*! 
    \mainpage Welcome to this code

    \section S1 Introduction
    Some stuff to explain why you coded all this

    \section S2 Examples
    Many examples of how the code can be used
    \cond NEVER
    !!! some line which you wouldn't write in a documentation
    \endcond

    \section S3 Some other stuff
*/

未能将部分S3放入主页...

2 个答案:

答案 0 :(得分:1)

以下内容:

/*! 
    \mainpage Welcome to this code

    \section S1 Introduction
    Some stuff to explain why you coded all this

    \section S2 Examples
    Many examples of how the code can be used
    \internal
    !!! some line which you wouldn't write in a documentation
    \endinternal

    \section S3 Some other stuff
*/
如果正确设置了doxyfile(将INTERNAL_DOCS标记设置为NO),则

达到预期目标。我知道@albert的提示。

答案 1 :(得分:1)

来自手册中的HTML commands section

  

最后,要在注释块中放置不可见的注释,可以使用HTML样式注释:

/*! <!-- This is a comment with a comment block --> Visible text */