Doxygen如何從通用接口中的overriden方法繼承文檔？

Question

我有一個接口Collection<T extends Item>，以及一個實現該接口Movies implements Collection<Movie>的類。該界面有幾個抽象方法可用於由電影覆蓋的排序。

我想知道的是，如何讓Doxygen使用類Movies中Collection.sort（）和Collection.safeSort（）的文檔？知道這一點很有用，因爲我可以爲接口編寫文檔，而不是每個接口的實現。如果我可以將文檔添加到重寫的方法中，那很好，但這不是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; } 
} 

這將允許基類中的文檔顯示在派生類文檔中，而不必複製它。