2014-07-08 110 views
1

我正在Groovy中編寫一個類,並且我想爲它生成Groovydoc(從命令行)。在我的課,我寫文檔,這樣的方法:Groovydoc生成空白文檔

/** 
* Returns blah blah blah 
*/ 
def getFoo(){ 
    ... 
} 

但是當我運行groovydoc -classpath C:\groovyStuff\ -d . *.groovy

它生成的HTML模板,但沒有實際內容。

我做錯了什麼?

+0

是當您運行命令時,當前目錄中的* .groovy文件? –

+0

不,他們在groovyStuff目錄中。我試圖在* .groovy文件 – Steve

回答

1

如果你的源代碼樹的根是c:\groovyStuff\你可以使用這樣的事情...

groovydoc -sourcepath c:\groovyStuff -d . com.somepackage 

-d .是有點奇特,因爲是打算把生成的文件在當前目錄中。這就是你在你的例子中使用的,但也許你想要類似-d output或類似的東西。

這有幫助嗎?

+0

sourcepath或classpath上運行命令?我以http://marxsoftware.blogspot.com/2011/05/documenting-groovy-with-groovydoc.html爲例。示例命令是朝向頁面的中間。我沒有得到這些文件需要成爲軟件包的一部分。 – Steve

+0

sourcepath和classpath是兩個不同的東西。我的意思是sourcepath,這就是我輸入的內容。例如,如果你有像'c:\ groovyStuff \ com \ somepackage \ Demo.groovy'和'c:\ groovyStuff \ com \ somepackage \ Widget.groovy'這樣的文件,我上面顯示的命令將會生成javadocs當前目錄(無論您執行該命令的目錄)。 –

+0

您可能需要也可能不需要指定類路徑。這取決於你的代碼在問題中沒有表示的細節。 –

1

對於Eclipse用戶,這裏是一個解決辦法:

  1. 轉到項目 - >生成的Javadoc ...
  2. 在Javadoc命令,用「groovydoc.bat取代 '的javadoc.exe' 路徑'路徑。
  3. 選擇要生成的來源,知名度和使用標準doclet(我建議你創建一個新文件的src/main/GroovyDoc的和刪除的src/main/javadoc中)

enter image description here