执行Eclipse从命令行生成javadoc

Question

我有一种情况，我想以下面的方式生成一个javadoc。

• 我想生成为整个项目
• 我想生成一个类的protected方法一个javadoc公共方法的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等？

Answer 1

您可以让eclipse生成一个ant构建文件。然后你可以在命令行中使用这个ant构建文件。

Answer 2

从帮助文件，您可以使用这些标志/参数的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 

或者，你可以使用一个构建工具，如Ant或Maven生成具有很好的包裹功能，为您的javadoc。下面是我的一个项目的ant 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>