【问题标题】:Force doxygen modules to begin with lower case letter强制 doxygen 模块以小写字母开头
【发布时间】:2013-06-19 04:37:06
【问题描述】:

我正在使用 doxygen 记录一个 C 项目,并将文件集合分组到模块中(其中每个模块都包含 c 样式类的所有文档)。我所拥有的一切工作正常,除了所有模块名称都以大写字母开头,即使我使用全小写名称创建模块组也是如此。

例如,以下 doxygen cmets 将在我的文档中生成一个模块“Foobar”,即使我添加到组“foobar”并希望该模块被称为“foobar”:

    /**
     *@addtogroup foobar
     *@{
     * (some documentation elements...)
     *@}
     */

虽然大写不会以任何严重的方式影响文档,但我想修复它以保持一致性(并且因为我不能让自己放手)。谷歌已经干了,有什么建议吗?

【问题讨论】:

  • 嗯。我也找不到解决办法。您确定您没有在其他地方引用 Foobar 导致该大写在某种“预处理”期间保持不变吗?而且,这是一个远景,但我看到的关于大写的唯一参考是svn.apache.org/repos/asf/subversion/trunk/doc/doxygen.conf 的“CASE_SENSE_NAMES”部分,但这与 doxygen 修改 your 大写无关。祝你好运!
  • 我确定,我将“addtogroup”语句切换为“defgroup”,以确保每个组名只使用一次。我想我会再google一下,如果没有出现,请提交错误报告。

标签: c doxygen


【解决方案1】:

我在doxygen manual 中差点错过这个:

要定义一个组,你应该把 \defgroup 命令放在一个特殊的注释块中。该命令的第一个参数是应该唯一标识组的标签。第二个参数是应该出现在文档中的组的名称或标题。

所以你应该可以做到

@addtogroup foobar foobar

【讨论】:

    【解决方案2】:

    answer by @E-rich 提供了一个可行的解决方案。

    但是,如果你使用

    \addtogroup foobar
    

    在很多地方/文件中,必须使用将是一个令人头疼的维护

    \addtogroup foobar foobar
    

    在所有这些地方。使用起来会更好:

    \defgroup foobar foobar
    

    然后离开使用

    \addtogroup foobar
    

    原样。

    根据我的建议,如果您愿意,可以轻松地将名称更改为更具描述性的名称。

    \defgroup foobar The Foo and Bar Module
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2021-02-26
      • 1970-01-01
      • 1970-01-01
      • 2023-03-24
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2022-11-23
      相关资源
      最近更新 更多