Javadoc наследует документацию родительских конструкторов

Учтите, что я расширяю класс, например:

public class MyComboBox<T> extends JComboBox<T> {

    public MyComboBox() {
        super();
    }

    public MyComboBox(ComboBoxModel<T> model ) {
        super(model);
    }

}

Повторное определение родительских конструкторов (которые подходят для моего нового класса, конечно) достаточно раздражает, но также копировать каждую конструкторскую документацию еще хуже. Не говоря уже о том, что это плохо для дальнейшего наследования, так как теперь мне приходится обновлять документацию несколько раз.

Очевидно, что {@inheritDoc} не будет работать, поскольку я не переопределяю ничего. Это, однако, поведение, которое я ищу. Есть ли способ достичь этого?

Как наследовать документацию родительских конструкторов?

Ответы

Ответ 1

Используйте тег @see и поместите имя класса и члена. Чтобы увидеть, как это выглядит, посмотрите JDocs, где вы можете перейти от javadoc к исходному коду.

Точный синтаксис:

 @see com.x.y.z.ClassName#methodName()

Ответ 3

Вы не можете переопределять конструкторы, поэтому нет необходимости распространять javadocs. Просто объясните, что клиент вашего объекта должен знать о том, как этот конкретный конструктор будет конструировать объект. Если он просто передает конструкцию расширенному объекту, тогда скажите только это.