2013-08-05 196 views
1

我有一種情況,我想以下面的方式生成一個javadoc。執行Eclipse從命令行生成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等?

回答

2

您可以讓eclipse生成一個ant構建文件。然後你可以在命令行中使用這個ant構建文件。

enter image description here

0

從幫助文件,您可以使用這些標誌/參數的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>