【问题标题】:Doxygen: Copy the description of a single parameterDoxygen:复制单个参数的描述
【发布时间】:2018-12-15 02:58:41
【问题描述】:

在我的源代码中,我经常得到具有相同参数的函数。因此对这个参数的描述也是一样的。我知道我可以使用 \copybrief、\copydoc 或 \copydetails 复制文档,但它们是否也可以复制单个参数的描述?或者有没有办法只在代码中管理这个参数的描述?

感谢您的帮助 m0nKey

【问题讨论】:

  • 谁能帮我解决这个问题? :-(
  • 据我所知,这个问题没有直接的解决方案,没有像@copyparam这样的命令。您是否查看了 ALIAS 命令(在 Doxyfile 中)来定义您自己的命令?
  • 我知道 ALIAS 命令,但是是否可以标记文本块并复制它?
  • 据我所知,没有任何功能可以抓取文本块并在另一个命令中使用它(\sn-p 命令除外,但这会产生代码,我不认为这是参数描述中的意图)。

标签: parameters doxygen


【解决方案1】:

因此,似乎没有解决方案可以用 doxygen 在代码中的某一点记录不同函数的相同参数。

【讨论】:

    【解决方案2】:

    看来我参加聚会有点晚了。还没有尝试过,但我注意到命令\includedoc <file-name>\snippetdoc <file-name> ( block_id )。它们似乎允许您将文档放入单独的文件中,然后将其包含到您的 doxygen 中,并在包含点将其“粘贴”并解析为 doxygen。因此,您可以拥有一个文档“sn-p”文件,并将您需要的 sn-p 包含到公共参数中。可能有帮助...

    编辑:用 1.8.11 尝试过,但没有用 :( 看来这可能是 1.8.13 的功能:See this SO thread

    【讨论】:

    • \sn-p 和 \include 只能复制“代码”(\code \endcode)。 AFAIK,它不适合参数。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2012-10-18
    • 1970-01-01
    • 1970-01-01
    • 2020-10-14
    • 2015-12-10
    • 2017-01-02
    • 1970-01-01
    相关资源
    最近更新 更多