apply plugin: "org.grails.grails-doc"文件
目的
為目前的 Grails 專案產生使用者指南和 Javadoc + Groovydoc API 文件。
範例
在您的 build.gradle 中加入外掛程式
現在執行指令
gradle docs說明
有些專案，特別是外掛程式，會受益於說明其運作方式的文件。Grails 自帶一個基於 wiki 語法的文件引擎，可以產生使用者指南的 HTML 和 PDF 版本，就像您目前正在閱讀的這個一樣。如果您在 src/docs 中有使用者指南的原始碼，這個指令會自動產生對應的 HTML 和 PDF 文件。
通常也有 API 文件會很有用。由於 Grails 是混合原始碼架構，這個指令也會產生 Javadoc（Java 文件的標準格式）和 Groovydoc API 參考的 HTML 表單。
文件會產生到下列目錄
-
docs/api- javadoc 註解的位置 -
docs/gapi- groovydoc 註解的位置 -
docs/guide- 使用者指南的位置 -
docs/ref- 使用者指南的參考區段位置
用法
grails doc參數
-
\--init- 建立範本專案文件專案（選用） -
\--pdf- 為專案文件建立 PDF 輸出（選用）
觸發的事件
-
DocStart- 文件產生開始前 -
DocEnd- 文件產生完成後