我有,我想生成以下方式一个javadoc的情况下。
- 我想生成整个项目的公共方法的Javadoc
- 我想生成一个类的protected方法一个javadoc。
这是很容易使用生成的Eclipse Javadoc工具来做,但它已被要求Javadoc生成这种情况下使用的,而不是Eclipse的GUI命令行或批处理脚本。
通过以下链接阅读后
http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#runningjavadoc
我明白,我怎么可以在命令行中使用javadoc工具,但它并没有告诉我,我会怎么选择的方法哪种类型的记录,并且它也出现,我必须列出每个类。
我的问题如下,
- 有没有一种方法来运行命令行Eclipse的风格Javadoc生成工具? 如果是的话我在哪里可以找到和实例如何做到这一点。
- 如果没有办法做到上面,有没有办法告诉javadoc工具仔细检查每一个包,内递归文档类?
- 有没有办法告诉javadoc工具来记录什么类型的方法,公共VS保护VS等?
您可以让月食产生Ant构建文件。 然后你可以使用命令行这只蚂蚁构建文件。
从帮助文件,你可以使用这些标志/参数的Javadoc:
-public Show only public classes and members
-protected Show protected/public classes and members (default)
-package Show package/protected/public classes and members
-private Show all classes and members
-help Display command line options and exit
-doclet <class> Generate output via alternate doclet
-docletpath <path> Specify where to find doclet class files
-sourcepath <pathlist> Specify where to find source files
-classpath <pathlist> Specify where to find user class files
-exclude <pkglist> Specify a list of packages to exclude
-subpackages <subpkglist> Specify subpackages to recursively load
另外,您也可以使用像蚂蚁构建工具或Maven生成具有很好的包裹功能,为您的javadoc。 这里是我的项目之一蚂蚁javadoc的目标:
<target name="javadoc" description = "generate javadoc from source">
<delete dir="javadoc" verbose ="true"/>
<javadoc packagenames ="my.app.*"
sourcepathref = "javadoc.sourcepath"
author ="true"
destdir = "javadoc"
windowtitle = "${project-name} API"
linksource= "yes"
overview="${src}/overview-summary.html"
access="public">
</javadoc>
</target>