函数过载，文档几乎相同

Question

我有两个acquire函数，除了它们的参数，文档是相同的。我该如何处理？我是否应该添加类似于“在函数X的文档中找到的相同的一般说明也适用于此处”？如果不是，Doxygen是否提供某种工具来处理这类情况？

ResourcePtr<T> acquire(const std::string& file); 
ResourcePtr<T> acquire(const void* buffer, std::size_t size); 

Answer 1

我不知道Doxygen，所以这个答案纯粹是我的文档方法。

当我在等，其中两个主题几乎相同的情况下记录，我任一重复在两个（优选的）的共享信息或我写类似于以下东西：

“函数Y是类似于函数x 。函数Y采用参数abc和[放置它在这里的工作方式] ...

有关这些函数的更多信息，请参见“。

在这种情况下，我会记录更简单的一个，并将更多信息添加到更复杂的信息。

第三种方法是从两者中分离出共同的文档，如果可能的话。

Answer 2

从This Page：

使用\ SA（另见）的关键字链接到相关的变量，方法或类。这是\ see标签的等效命令。