Doxygen, как наследовать документы от переопределенных методов в универсальном интерфейсе? - PullRequest
Новая
       4

Doxygen, как наследовать документы от переопределенных методов в универсальном интерфейсе?

2 голосов
/ 21 октября 2011

У меня есть интерфейс Collection<T extends Item> и класс, который реализует этот интерфейс Movies implements Collection<Movie>.В интерфейсе есть несколько абстрактных методов для сортировки, которые переопределяются фильмами.

Я хочу знать, как я могу заставить Doxygen использовать документацию из Collection.sort () и Collection.safeSort ()в классе кино?Было бы полезно знать, потому что тогда я могу написать документацию для интерфейса, а не каждую реализацию интерфейса.Если бы я мог -добавить документацию к переопределенным методам, это было бы замечательно, но это не обязательно на 100%.

INHERIT_DOCS, кстати, установлен на YES, я считаю, что Doxygen борется, потому чтореализует Collection<Movie>, а не Collection<T extends Item>.

1 Ответ

5 голосов
/ 28 декабря 2011

Похоже, есть ряд ошибок, связанных с 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; }
}

Это позволит отображать документацию базового класса в документации производного класса, не копируя ее.

...