scope - 多个库的文档，多个平台具有相同的类名

Question

从 2005 年到现在，我花了相当长的时间浏览帖子。我的用例是一个 doxygen 项目，用于记录多个库以支持多个微处理器。

例如，我有 10 个不同的微处理器平台，每个平台都有自己的库。每个处理器都有串行通信，所以我创建了一个名为 serialClass 的 C++ 类。因为每个处理器的底层实现不同，所以有10个文件，每个文件都有一个名为serialClass的类，每个文件名为serialdriver.h。对于此示例，让我们使用一个名为 serialClass::sendByte() 的成员函数。

我意识到 doxygen 专注于单个项目，所以我认为我制作库的用例可能不适合。这个用例的结果是 doxygen 将处理每个 serialdriver.h 文件，生成的文档将为每个处理器平台提供 10 个 serialClass::sendByte() 列表。

通过论坛搜索，最常见的答案是使用命名空间。但是，这对于多个库文件没有意义，并且还会破坏现有的客户代码（我们已经有 24 年了）。我最接近的是这个论坛帖子：http://doxygen.10944.n7.nabble.com/Documenting-two-files-with-the-same-name-in-two-different-folders-FORTRAN-td4526。 .html _ 本质上，它创建了一个只有 doxygen 知道的命名空间：

在 doxygen 配置文件中： PREDEFINED = DOXYGEN_STUFF

在您的代码中：#ifdef DOXYGEN_STUFF namespace serialClassNamespace { #endif

这实际上实现了能够使用相同的类和/或函数名称的目标，但“faux”命名空间出现在所有成员函数文档中。如果有某种方法可以消除命名空间，那么文档看起来会很好。例如，我们希望在文档中显示的是：

串行类::sendByte()

但我们得到的是：

serialClassNamespace::serialClass::sendByte()

如果我只有 serialClass::sendByte() 就好了。我尝试了配置设置：HIDE_SCOPE_NAMES=YES，但这摆脱了所有范围，所以你最终只得到了 sendByte()。除了命名空间之外，我仍然需要所有东西，因此子类对用户仍然有意义。在这种情况下，我想要 serialClass::sendByte()。

我确实意识到这不是最初的意图，但是由于可以删除所有范围，是否可以只删除命名空间？

总而言之，虽然为（当前）10 个平台中的每一个创建命名空间都可以工作，但客户更容易知道相同的类和代码在没有命名空间的情况下适用于所有平台，以便于记录。是否可以从成员函数中仅删除名称空间前缀？如果命名空间页面引用它，它完全没问题，只是试图让类成员函数对读者有意义。

将 SHOW_NAMESPACES 设置为 NO 只会删除命名空间索引页面。

将 HIDE_SCOPE_NAMES 设置为 YES 会删除类范围以及命名空间。

我们最后的手段是为这些创建单独的 doxyge 项目，但是参考并不容易理解。

谢谢您的考虑。

标签： scopenamespaceshide