【问题标题】:Doxygen: Nested structure namingDoxygen:嵌套结构命名
【发布时间】:2013-03-06 12:39:15
【问题描述】:

当使用 doxygen 来记录如下的嵌套 C 结构时 -

struct level0 {           
    struct level1 {             
        struct level2 {            
            int data1;            
        } var_level2a;           

        struct level2b {      
            int data2;       
            int data3;       
        } var_level2b;       

    } var_level1;     
};      

生成的文档结构命名为this -

  • struct level0::level1::level2a
  • struct level0::level1::level2b

我们可以像这样简单地显示结构名称吗(在内部它可能有完整的名称,范围解析为'::'的东西用于引用) -

  • 结构级别2a
  • 结构级别2b

请提供帮助。快速响应将非常有帮助。

【问题讨论】:

  • 这是明确的,我相信。你可以清楚地看到那里的结构。
  • 感谢您的回复。在歧义问题中确实是安全的。我们对内部结构有唯一的名称,所以它不会冲突。但问题是当 doxygen 读取定义结构的嵌套样式时,它使用此 '::' 范围解析。这使得结构名称很长并且对于不熟悉 doxygen 的普通读者来说是混乱的。所以我们的要求是在 RTF 文档中只有结构短名称。这可以通过任何方式实现吗? ...在@ref 中,我们可以指定链接“标签”;但这是自动生成的链接,我们似乎无法对其进行控制。

标签: struct doxygen rtf


【解决方案1】:

您是否尝试将HIDE_SCOPE_NAMES 设置为YES

【讨论】:

  • 您好 Doxygen,感谢您的回复。是的,我们试过了,但这并没有解决问题。实际上,如果我们将此 HIDE_SCOPE_NAMES 设置为 YES 或 NO,我无法找出它在输出文档中所做的更改。根据我的经验,我发现在某些情况下,配置文件的设置参数并不总是像他们所说的那样工作。我正在使用最新版本的 Doxygen,Windows 和 Linux 版本都存在问题。既然你创建了这个工具,你能建议是否有一个稳定的(并且具有与最新的功能几乎相同的)版本,上面所说的东西可以工作吗?
  • 如果您发现某些东西没有按文档或预期工作,那么请在 doxygen 的错误跟踪器中提交错误报告并包含一个独立的示例(配置文件 + zip 或 tar 中的源代码)。我只能解决我可以重现的问题。 Doxygen 有 200 多个选项,因此我无法测试所有可能的设置。
猜你喜欢
  • 2011-11-15
  • 1970-01-01
  • 1970-01-01
  • 2023-03-19
  • 1970-01-01
  • 2011-04-28
  • 2019-05-27
  • 1970-01-01
  • 2019-08-17
相关资源
最近更新 更多