在API文档中切换方法的继承和非继承视图?

时间:2015-12-25 03:22:34

标签: c++ doxygen

我们有一个C ++库,我们使用Doxygen来获取API文档。该文档是使用Doxygen 1.8.10构建的。

我正在和我们的一个用户交谈,他们希望API文档只显示类的非继承方法(而不是 not 重写的继承方法)。这是请求:

  

其中一个问题就是doxygen。我显然是Qt用户和Qt   docs一直很好。关于doxygen的事情是Qt docs only   显示类的实现和虚函数。这让我看到了   类在其继承的类之上提供了什么。所以,如果我想知道   FileSink和StringSink之间的区别,它会更加明显。看着   doc.qt.io/qt-5/qiodevice.html(粗略等效于过滤器)然后   比较后代类QFile和QNetworkReply。而doxygen   只列出一切,Qt文档告诉我这是什么特别的   类。这可能只是一个很长的路要走。

如何告诉Doxygen以显示类文档的方式为用户提供选择?也就是说,它应该允许用户查看所有类的方法(继承和非继承)或仅查看类添加的方法(即覆盖和非继承)。

甚至可以使用Doxygen更改视图吗?

提前致谢。

我在Doxygen中唯一能找到的是以下内容,但它是一个构建时设置。它不是用户可以做出的观看时间选择:

# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.

INHERIT_DOCS           = YES

问题类似于Mark overridden functions和朋友。但我们正在寻找一个“切换”视图时间选项。也就是说,我们希望在视图时为用户提供一个选择,而不是在构建时强制它们。

0 个答案:

没有答案