Как остановить javadoc от создания документации для суперклассов?

Question

Контекст: NetBeans 8.0.2, Java 8.0.0

я написал пару классов инкапсулировать диалогах, чтобы помочь своим студентам в написании простых, наглядных приложений без сложного знания GUI программирования - Tic-Tac-Toe , например. К сожалению, я сделал некоторые из классов, расширяющих JFrame, и теперь мой javadoc завален длинными списками функций, унаследованных от иерархии классов, что делает его похожим на запугивание.

Я знаю, что могу переформулировать мою стратегию реализации, чтобы «использовать» JFrame, а не «быть» JFrame, но есть ли более простой способ сказать javadoc просто не генерировать документацию на основе иерархии классов?

Спасибо.

Edit:

Я использую генератор NetBeans вне коробки, с этими дополнительными опциями:

-stylesheetfile C:\Users\jack\Documents\NetBeansProjects\CartesianPlane/src/customStylesheet.css -overview "C:\Users\jack\Documents\NetBeansProjects\CartesianPlane/src/Overview.html" -subpackages edu.pcwe.uw.javaintro.cartesian_plane -exclude edu.pcwe.uw.javaintro.cartesian_plane.test 

Answer 1

Этот вопрос уже перечисленных в Javadoc FAQ

A16. Как я могу исключить или пропустить некоторые публичные участники или классы из документально оформленных документов?

[...] Там в настоящее время нет опции Javadoc, чтобы скрыть, исключить или подавления представителей общественности из документации JavaDoc сгенерированные.

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

Существует an issue scheduled for version 9, где запрашивается тег exclude.

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

Edit:

yDoc (теперь переименован yWorks как на ваш комментарий) Doclet в упоминалось просьбе я связан дают возможность сделать некоторые исключения, используя y.exclude.

Обратите внимание, что вам будет необходимо указать y.exclude на свой суперкласс. Поскольку JFrame является частью стандартного JDK, вы не сможете указать его. Если вы не захотите перекомпилировать его, конечно, но хорошо знать, что у вас есть обходное решение для ваших собственных занятий.