Doxygen \cond 不工作

Doxygen \cond not working

我正在 .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.

你试过了吗:

For conditional sections within a comment block one should use a \if ... \endif block.

\cond 的文档所述?

\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.