Doxygen \ cond无法正常工作

时间:2015-04-25 18:48:10

标签: comments doxygen

我正在.dox文件和魔杖中写一些软件的文档,以包含一些不会在网页中显示的评论。我正在使用\cond但是在调用\endcond后我没有得到任何输出。

/// \section cuboids_sec Cuboids
///
/// \cond
///   [TODO]
/// \endcond
///
/// - \b Cuboid - Polyhedron bounded by six quadrilateral faces.
/// - \b Rectangular \b Cuboid - Cuboid with rectangular faces. 
///   Then each pair of adjacent faces meet in a right angle. By 
///   definition, a rectangular cuboid is also a right rectangular 
///   prism.

2 个答案:

答案 0 :(得分:3)

当你想要隐藏一些代码时,可以使用

\cond

内部doxygen将结束\cond处的评论,并在\endcond之后重新开始评论。因此,示例中的第二部分不再属于任何页面。

要跳过部分评论,请使用\if

/// \section cuboids_sec Cuboids
///
/// \if HIDDEN
///   [TODO]
/// \endif
///
/// - \b Cuboid - Polyhedron bounded by six quadrilateral faces.
/// - \b Rectangular \b Cuboid - Cuboid with rectangular faces. 
///   Then each pair of adjacent faces meet in a right angle. By 
///   definition, a rectangular cuboid is also a right rectangular 
///   prism.

答案 1 :(得分:1)

你试过了吗?

  

对于注释块中的条件部分,应使用\ if ... \ endif块。

\cond的文档中所述