Я должен исключить несколько общедоступных методов класса из включения в javadocs. Я попробовал ExcludeDoclet Криса Ноклеберга (шестиногий). Но доклет создает небольшую проблему: если другие методы в классе возвращают список (или любые другие дженерики), вместо того, чтобы отображаться в javadoc как список, возвращаемый тип просто отображается как список (без общей информации)
Может ли кто-нибудь дать подсказку или предоставить работу по решению этой проблемы?
Я предполагаю, что методы, которые вы хотите исключить из javadoc, являются общедоступными методами, которые вы не хотите, чтобы ваш клиент использовал. Другими словами, эти методы устарели. Что вам нужно сделать, так это использовать аннотацию @Deprecated. Так:
@Deprecated public void badMethod() {
...
}
Теперь badMethod() устарел. Если кто-то использует badMethod() в своем коде, он получит предупреждение от компилятора (о том, что он использует устаревший метод).
Однако аннотация @Deprecated не исключает устаревший метод из javadoc. Вот что вам нужно сделать, чтобы исключить метод из javadoc: При создании javadoc используйте nodeprecated параметр строки javadoc cmd. Параметр -nodeprecated предотвращает создание любого устаревшего API в документации. Поэтому, если вы используете аннотацию @Deprecated и создаете javadoc с параметром -nodeprecated, ваш плохой метод не появится в javadoc.
Но, на мой взгляд, вы не должны исключать устаревшие общедоступные методы из своего javadoc. Лучше, если они появятся в документации с объяснением, почему метод устарел и что использовать вместо него.
