c++ - 记录跨越多个文件的 namespace doxygen

Question

假设我有 2 个头文件。

// HEADER 1
/**
 * Doc  for Foo here?
 */
namespace Foo {
  class This {...};
}

&&

// HEADER 2
/**
 * Doc for Foo here?
 */
namespace Foo {
  class That {...};
}

在使用 Doxygen 记录时我应该如何处理这个问题？

Answer 1

也许两者都不是。

例如，假设您有 "<root>/utility/header1.hpp"其内容在 namespace utility 中和 "<root>/utility/header2.hpp"这也是。

您可以添加一个文件:"<root>/utility.hpp"其中记录了实用程序命名空间。你可以把它放在顶部 #error Documentation only.以确保它不会意外包含在内。

但我建议至少制作一些偏僻的文件以将其保存在一个合理的地方(而不是与某些类随机混合。)