【问题标题】:Is there a way to refer to the class' @brief in the doxygen?有没有办法在 doxygen 中引用班级的@brief?
【发布时间】:2021-06-16 08:15:09
【问题描述】:

假设,我们有以下 doxygen 评论:

/**
 * @brief The cool class.
 *
 * More info...
 */
class A {};

我想要那个“酷课”。简介已经出现在一些任意的地方。例如,我想制作一个包含一些任意类列表及其简要描述的表格。所以,我可以选择在这里手动编写简报,但看起来这个简报会和那些简报一样。因此,最好在此表中进行一些构造以跳过信息加倍。

【问题讨论】:

  • 您使用哪个版本的 doxygen?尽管给出了答案:到目前为止,您尝试了什么?
  • doxygen 的版本是 1.9.1。

标签: c++ doxygen


【解决方案1】:

我认为\copybrief 命令很适合这个,只是一个带有列表的模型:

/// \file
///
/// Lets try to make a list:
/// - \copybrief A
/// - \copybrief B

/// \brief The cool class
class A {};

/// \brief The other cool class
class B {};

这会导致文件详细描述中的列表:

【讨论】:

  • 哇!这个很酷!看起来有人在我之前已经面临过这个问题。
  • 是的,我在 1.5.6 版本中发现了第一次出现。 (2008 年 5 月 18 日)
猜你喜欢
  • 2017-04-06
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2010-11-04
  • 1970-01-01
  • 1970-01-01
  • 2011-05-02
  • 1970-01-01
相关资源
最近更新 更多