【问题标题】:Comments in Doxygen .dox fileDoxygen .dox 文件中的注释
【发布时间】:2014-11-24 15:38:53
【问题描述】:

我有一个 .dox 文件,并且想要插入一些不会插入的 cmets 显示在实际文档中。

尝试仅使用//,Horever,当我尝试时,所有文本都被删除了。

/// \defgroup desc_polyhedra Polyhedra
///
// If you want to prevent that a word that corresponds to a 
// documented class is replaced by a link you should put a % in 
// front of the word.
///
/// \section Polyhedron 
///
/// A polyhedron is a solid in three dimensions with flat faces, 
/// straight edges and sharp corners or vertices. 
///
/// Amongst the many examples of polyhedra, the Cuboid and 
/// Prismatoid structures will be considered in more detail. 
/// Here is a brief summary of cuboids and prismatoids.

【问题讨论】:

    标签: comments doxygen


    【解决方案1】:

    这里有几个选项:

    1. \cond...\endcond包围你想单独留下的文字

    2. 有一个完全独立的评论部分,只有 // - 即不要在/// 部分的中间混合//。您看到的是第一个 // 结束了 doxygen 注释块,因此它停止在输出中出现。

    3. 在 doxygen 部分使用 HTML 注释语法/// <--! A comment is here -->

    【讨论】:

    • 我正在使用\cond ... \endcond
    猜你喜欢
    • 2012-08-25
    • 1970-01-01
    • 2015-07-05
    • 1970-01-01
    • 2023-03-12
    • 2012-02-28
    • 1970-01-01
    • 2014-04-29
    • 2011-09-05
    相关资源
    最近更新 更多