java - Doxygen 如何从通用接口(interface)中的重写方法继承文档？

Question

我有一个接口(interface) Collection<T extends Item> ，以及实现该接口(interface)的类 Movies implements Collection<Movie> .该接口(interface)有几个用于排序的抽象方法，它们被 Movies 覆盖。

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

INHERIT_DOCS设置为 YES顺便说一句，我相信 Doxygen 正在苦苦挣扎，因为它实现了 Collection<Movie>而不是 Collection<T extends Item> .

Answer 1

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

• https://bugzilla.gnome.org/show_bug.cgi?id=516656
• https://bugzilla.gnome.org/show_bug.cgi?id=583958
• https://bugzilla.gnome.org/show_bug.cgi?id=631675

作为解决方法，您可以使用@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; }
}

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