记录跨多个文件的名称空间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.，以确保它不被意外包含。

但我建议至少制作一些偏僻的文件，以将其保存在合理的位置（并且不要与某些班级随意混用）。