documentation - 如何在 doxygen 文档中向 protected 代码块添加注释

标签 documentation doxygen

我在 Doxygen 中使用 markdown 语法使用围栏代码块。这样可以很容易地添加一个简单的代码示例,如下所示:

~~~~~{.cpp}
void doSomething()
   {
   }
~~~~~

当我尝试使用两个正斜杠将注释添加到 protected 代码块中时,Doxygen 似乎删除了斜杠。所以当我写这个时:
~~~~~{.cpp}
void doSomething()
   {
   // This function should do something
   }
~~~~~

我得到这个输出:
void doSomething()
   {
This function should do something
   }

我如何告诉 Doxygen 将注释保留在 protected 代码块中?

编辑:

完整的文件如下所示(我们使用 .dox 的标准 Doxygen 扩展名作为纯文档文件):
/*!
\page PATTERN_SAMPLE Sample

~~~~~{.cpp}
void doSomething()
   {
   // This function should do something
   }
~~~~~
*/

结果如下所示:
Result

最佳答案

尝试使用\code

  \code{.cpp}
  class Cpp {};
  \endcode

关于documentation - 如何在 doxygen 文档中向 protected 代码块添加注释,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/17426815/

相关文章:

php - 自动生成 PHP 文档?

tensorflow - 是否有 dnnlib : additional lib in projects of NVlabs? 的任何文档

objective-c - Objective-C 的文档生成器?

c++ - Doxygen:识别所有 C++ 注释

c++ - 如何在 Doxygen 中记录一个单词,它是代码中的实体名称,但在当前上下文中不是?

javascript - 声明函数触发 Polymer 元素中的事件的正确方法是什么?

documentation - 如何控制Doxygen文档部分的顺序?

doxygen - 在 doxygen 中使用\internal 来隐藏结构的内部元素

variables - 将静态变量的初始值的 doxygen 复制到\file block

javascript - 如何为 gulp 任务编写 Auto 文档?