代码之家  ›  专栏  ›  技术社区  ›  Emiliano

在doxygen[duplicate]中添加自定义命令

  •  4
  • Emiliano  · 技术社区  · 15 年前

    我想在我的doxygen文档中添加一个自定义命令。基本上,对于我为之编写文档的每个C函数,我需要在读模式或写模式下编写哪些全局变量被“接触”。它就像“请参阅”列表,只是标题不同。

    在我的文件中,我想这样写:

    /*
     * \read-globals   #var1, #var2
     *
     * \write-globals  #var3
     */
    

    read-globals = \par <b>Globals read</b>\n
    

    它可以工作,但我担心它是独立于样式表的:如果明天我想更改css,那么这个自定义命令将生成与SeeAllow、author和所有其他部分不同的输出。

    另一个选项是使用\xrefitem命令,该命令也可以使用,但它需要引入一个节作为第二个参数,这在我的情况下是完全无用的(也许它可以以某种方式隐藏?)。

    有没有“正确的方法”来实现我的目标?

    1 回复  |  直到 15 年前
        1
  •  4
  •   Community CDub    7 年前

    你可以合并 \xrefitem ALIASES 如果要隐藏第二个参数。以下是我用于需求的示例:

    ALIASES += "req=\xrefitem req \"Requirement\" \"Requirements\" "
    

    然后在文档化代码中:

    /// \req #42 The system shall work in any situation
    

    (根据我对该问题的回答: Custom tags with Doxygen )