【问题标题】:What is the correct syntax for using EXCLUDE_SYMBOLS?使用 EXCLUDE_SYMBOLS 的正确语法是什么?
【发布时间】:2013-11-21 07:12:07
【问题描述】:

我有这样的课:

class Foo {
public:
  /** blah blah */
  void bar();
}

我想将其从文档中排除,但 EXCLUDE_SYMBOLS 不适合我。我已经尝试了以下(一一):

EXCLUDE_SYMBOLS = Foo::bar
EXCLUDE_SYMBOLS = Foo::*
EXCLUDE_SYMBOLS = Foo
EXCLUDE_SYMBOLS = *

这些都不起作用。我的语法是否有错误,或者我需要更改其他配置才能使其生效?

我查看了几个关于 SO 的问题,但这些答案中使用的语法对我不起作用。

【问题讨论】:

  • 根据手册,该语法看起来正确。您实际上是在使用该代码测试问题还是这只是问题的说明。我问是因为如果实际上您有多个条目,请注意条目之间的分隔符(例如逗号)在 doxyfile 注释和 doxyfile 语法之间可能不同(例如,FILE_PATTERNS 显示 commas 在描述,但需要空格 - 并且不能使用逗号。)
  • 好点,我不知道这个问题。我也尝试过使用单个条目(没有分隔符),但不起作用。让我再做几个实验。
  • 好吧,我用我在这个问题中发布的完全相同的代码和配置做了另一个实验,但它仍然不适合我。
  • 我现在没有想法了 :-( 你使用的是什么版本的 Doxygen?如果不是最新版本,更新会有什么不同吗?(好吧,所以不太可能)。
  • 我遇到了完全相同的问题,@MaskedMan。你最终解决了吗?

标签: doxygen


【解决方案1】:

这个排除表达式在我使用 doxygen 1.8.14 的情况下效果很好:

EXCLUDE_SYMBOLS = "TestTemplate< T, std::string >" "TestNS::*" "TestClass*"

在 EXCLUDE_SYMBOLS 中,它是指定的或确切的符号名称或“*”模式。可以从 doxygen XML 输出中检索确切的符号名称(尝试在 Doxyfile 中启用它)。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2014-04-19
    • 2018-11-14
    • 2019-09-07
    • 1970-01-01
    • 1970-01-01
    • 2023-01-25
    • 1970-01-01
    相关资源
    最近更新 更多