Doxygen如何从泛型接口中的overriden方法继承文档？

Question

我有一个接口Collection<T extends Item>,以及一个实现该接口的类Movies implements Collection<Movie>.该界面有几种抽象方法可供电影覆盖.

我想知道的是,我怎样才能让Doxygen在类电影中使用Collection.sort()和Collection.safeSort()中的文档？知道它是有用的,因为那时我可以编写接口的文档,而不是接口的每个实现.如果我可以-add-文档到被覆盖的方法,那将是伟大的,但这不是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; }
}

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