DocEngine (Grace Framework - 2023.3.0)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

grails.doc.DocEngine

All Implemented Interfaces and Traits:

WikiRenderEngine
```
class DocEngine
extends BaseRenderEngine
implements WikiRenderEngine
```
A Radeox Wiki engine for generating documentation using a confluence style syntax.
Authors:
Graeme Rocher
Since:
1.2

Properties Summary

Properties
Type	Name and description
`static Object`	`ALIAS`
`static Object`	`API_BASE_PATH`
`static Object`	`API_CONTEXT_PATH`
`static Object`	`BASE_DIR`
`static Object`	`CONTEXT_PATH`
`static Object`	`EXTERNAL_DOCS`
`static Object`	`NAME_CACHE` Converts a property name into its natural language equivalent eg ('firstName' becomes 'First Name')
`static Object`	`RESOURCES_CONTEXT_PATH`
`static Object`	`SOURCE_FILE`
`Properties`	`engineProperties`

Constructor Summary

Constructors
Constructor and description
`DocEngine(InitialRenderContext context)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addMacro(Object macro)`
	`void`	`appendCreateLink(StringBuffer buffer, String name, String view)`
	`void`	`appendLink(StringBuffer buffer, String name, String view, String anchor)`
	`void`	`appendLink(StringBuffer buffer, String name, String view)`
	`boolean`	`exists(String name)`
	`String`	`getNaturalName(String name)`
	`protected void`	`init()`
	`boolean`	`showCreate()`

- Property Detail
  - static final Object ALIAS
  - static final Object API_BASE_PATH
  - static final Object API_CONTEXT_PATH
  - static final Object BASE_DIR
  - static final Object CONTEXT_PATH
  - static final Object EXTERNAL_DOCS
  - static final Object NAME_CACHE
    
    Converts a property name into its natural language equivalent eg ('firstName' becomes 'First Name')
    Parameters:
    name - The property name to convert
    Returns:
    The converted property name
  - static final Object RESOURCES_CONTEXT_PATH
  - static final Object SOURCE_FILE
  - Properties engineProperties
- Constructor Detail
  - DocEngine(InitialRenderContext context)
- Method Detail
  - void addMacro(Object macro)
  - void appendCreateLink(StringBuffer buffer, String name, String view)
  - void appendLink(StringBuffer buffer, String name, String view, String anchor)
  - void appendLink(StringBuffer buffer, String name, String view)
  - boolean exists(String name)
  - String getNaturalName(String name)
  - protected void init()
  - boolean showCreate()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method