Documentation 函数重载，文档几乎相同

我有两个

acquire

函数，除了它们的参数外，文档是相同的。我该怎么处理？我是否应该添加类似“函数X文档中相同的一般注释也适用于此处”？如果没有，Doxygen是否提供了处理此类案件的某种工具

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

ResourcePtr-acquire（const-std:：string和file）；
ResourcePtr acquire（const void*buffer，std:：size\u t size）；

来自：

使用\sa（另请参见）关键字链接到相关变量、方法或类。这是相当于\see tag.

的命令，来自：

---

使用\sa（另请参见）关键字链接到相关变量、方法或类。这是相当于\see tag的命令。

我不知道Doxygen，所以这个答案完全是基于我的文档方法

当我在两个主题几乎相同的情况下编写文档时，我要么重复两个主题中的共享信息（首选），要么编写类似于以下内容的内容：

“函数Y与函数X类似。函数Y接受参数abc，并[在此处说明其工作方式不同]

有关这些功能的详细信息，请参阅。“

在本例中，我将记录简单的一个，并将附加信息添加到更复杂的一个

---

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

我不知道Doxygen，所以这个答案完全取决于我的文档方法

当我在两个主题几乎相同的情况下编写文档时，我要么重复两个主题中的共享信息（首选），要么编写类似于以下内容的内容：

“函数Y与函数X类似。函数Y接受参数abc，并[在此处说明其工作方式不同]

有关这些功能的详细信息，请参阅。“

在本例中，我将记录简单的一个，并将附加信息添加到更复杂的一个

---

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

我不确定\sa的预期用途是什么。我以前使用过它，但只用于某些相关的类，而不是用于引用其他文档。我不确定这是否是\sa的预期用途。我以前使用过它，但只用于以某种方式相关的类，而不是用于引用其他文档。