【问题标题】:Use doxygen file header as module description使用 doxygen 文件头作为模块描述
【发布时间】:2016-07-13 05:26:50
【问题描述】:

我想知道是否有可能将 doxygen 文件头描述也用于模块描述。

/**
   \file               
   \brief         Some brief info
   \details       more Details
*/
/**
   \defgroup Views
   \brief (Same as header doxy)
   \details (Same as header doxy)
*/

为避免冗余,我不会复制文本。如果我将 defgroup 移动到文件顶部,我只会得到模块中提到的文件名,而不是描述。我已经尝试了一些组合,但我从未实现我的目标。详细和简短的文本要么在模块文档中,要么在文件文档中。有没有人知道如何重用文本?

非常感谢,

强尼

【问题讨论】:

    标签: c documentation grouping doxygen


    【解决方案1】:

    我自己找到了解决方案。 您可以使用 doxy 命令 @copydoc 来复制文档。

    我的 test.h 代码如下所示:

    /**
       \file          test.h
       \brief         Some brief info
       \details       more Details
    */
    /**
       \defgroup Views
       @copydoc view.h
    */
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2011-11-09
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2014-10-26
      • 2017-01-31
      • 1970-01-01
      相关资源
      最近更新 更多