"Fossies" - the Fresh Open Source Software Archive

Member "grails-core-5.2.4/grails-docs/src/test/resources/docs/ref/Command Line/docs.html" (14 Sep 2022, 60804 Bytes) of package /linux/www/grails-core-5.2.4.tar.gz:


Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. You can here alternatively try to browse the pure source code or just view or download the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the grails-core-5.2.4.tar.gz project site itself.

(Quick Reference)

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.

The documentation is generated to the following directories:

  • docs/api - Location of javadoc comments

  • docs/gapi - Location of groovydoc comments

  • docs/guide - Location of the user guide

  • docs/ref - Location of the reference section of the user guide

Usage:

grails doc

Arguments:

  • \--init - Create a template project documentation project (optional)

  • \--pdf - Create PDF output for project documentation (optional)

Fired Events:

  • DocStart - Before documentation generation begins

  • DocEnd - After documentation generation completes