Doxygen 如何从通用接口中的重写方法继承文档？

【问题标题】：Doxygen how to inherit documents from overriden methods in a generic interface?Doxygen 如何从通用接口中的重写方法继承文档？
【发布时间】：2011-12-12 05:50:48
【问题描述】：

我有一个接口Collection<T extends Item>，以及一个实现该接口Movies implements Collection<Movie> 的类。该接口有几个被电影覆盖的抽象排序方法。

我想知道的是，如何让 Doxygen 在电影类中使用 Collection.sort() 和 Collection.safeSort() 中的文档？知道会很有用，因为这样我就可以为接口编写文档，而不是为接口的每个实现编写文档。如果我可以将文档添加到被覆盖的方法中，那就太好了，但这不是 100% 必要的。

INHERIT_DOCS 设置为 YES

【问题讨论】：

标签： java generics doxygen

【解决方案1】：

似乎存在许多针对 doxygen 的与此类行为相关的错误，请参阅以下示例：

对于解决方法，您可以使用 @copydoc 将基类中的文档引入派生类，例如：

/**
 * Movies
 */
public class Movies extends Collection<Movie> {
    /**
     * @copydoc Collection<T extends Item>::sort()
     *
     * Additional documentation specific to Movies::sort().
     */
    public void sort(void) { return; }
}

这将允许基类中的文档出现在派生类文档中，而无需复制它。

【讨论】：

谢谢。由于其他原因，我实际上已经重构了代码，但了解未来很有用。