Resource Documentation

For get resources documentation you need add a resource block to resource controller:

# =begin resource
# ...
# =end

If you use controllers_route parameter in config:

# =begin resource
...
# =end

Parameters

• description: resource description.

Examples

# =begin resource
# description: >
#   Represents an user in the system.
#   User recourse is the main element of the application.
# =end

You can use array format for multiple paragraphs.

# =begin resource
# description:
#   - Represents an user in the system.
#   - User recourse is the main element of the application.
# =end

If you use controller_route options (.yml):

 # =begin resource
 description: >
   Represents an user in the system.
   User recourse is the main element of the application.
 # =end