docs

Purpose

Generates a user guide and Javadoc + Groovydoc API documentation for the current Grails project.

Examples

Add the plugin in your build.gradle:

apply plugin: "org.grails.grails-doc"

Now run the command

gradle docs

Description

Some projects, particular plugins, benefit from documentation explaining how they work. Grails comes with its own documentation engine based on a wiki syntax that can generate both HTML and PDF versions of a user guide, just like the one you are currently reading. If you have the source for a user guide in src/docs, then this command will automatically generate the corresponding HTML and PDF documents.

It’s often useful to have API documentation as well. Since Grails is a mixed source framework, the command also generates both Javadoc (the standard format for Java documentation) and Groovydoc API references in HTML form.

Plug-ins

Services

Servlet API

Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.