如何阻止javadoc生成超类的文档?

时间:2015-06-05 16:38:31

标签: java javadoc

上下文:NetBeans 8.0.2,Java 8.0.0

我编写了几个类来封装对话框,以帮助我的学生编写简单的可视化应用程序,而无需熟悉GUI编程 - 例如Tic-Tac-Toe。不幸的是我做了一些扩展JFrame的类,现在我的javadoc上堆满了从类层次结构中继承的长列表,使它看起来有些令人生畏。

我知道我可以将我的实施策略重新制定为"使用"一个JFrame,而不是" be"一个JFrame,但有没有一些更简单的方法告诉javadoc不要根据类层次结构生成文档?

感谢。

修改:

我正在使用开箱即用的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

1 个答案:

答案 0 :(得分:4)

此问题已在Javadoc常见问题解答中列出

  

A16。如何排除或跳过某些公共成员或班级   从被记录?

     

[...]目前没有隐藏,排除或的Javadoc选项   从javadoc生成的文档中压制公共成员

由于它是自动生成的,而您无法排除,因此您必须处理它。

an issue scheduled for version 9要求exclude代码。

您可能希望阅读整个请求,因为它提供了一些排除的解决方法,但我不确定它是否适合您的情况。

修改:

yDoc(根据您的评论重新命名为yWorks)我在链接的请求中提到的doclet提供了使用y.exclude进行排除的可能性。

请注意,您必须在超类上指定y.exclude。由于JFrame是标准JDK的一部分,因此您无法指定它。除非您想重新编译它,否则很高兴知道您有一个解决方法来为您自己的类执行此操作。