class DocEngine extends org.radeox.engine.BaseRenderEngine
A Radeox Wiki engine for generating documentation using a confluence style syntax.
| Type | Name and description | 
|---|---|
| static java.lang.Object | ALIAS | 
| static java.lang.Object | API_BASE_PATH | 
| static java.lang.Object | API_CONTEXT_PATH | 
| static java.lang.Object | BASE_DIR | 
| static java.lang.Object | CONTEXT_PATH | 
| static java.lang.Object | EXTERNAL_DOCS | 
| static java.lang.Object | RESOURCES_CONTEXT_PATH | 
| static java.lang.Object | SOURCE_FILE | 
| java.util.Properties | engineProperties | 
| static java.lang.Object | nameCacheConverts a property name into its natural language equivalent eg ('firstName' becomes 'First Name') | 
| Constructor and description | 
|---|
| DocEngine
                                (org.radeox.api.engine.context.InitialRenderContext context) | 
| Type Params | Return Type | Name and description | 
|---|---|---|
|  | void | addMacro(java.lang.Object macro) | 
|  | void | appendCreateLink(java.lang.StringBuffer buffer, java.lang.String name, java.lang.String view) | 
|  | void | appendLink(java.lang.StringBuffer buffer, java.lang.String name, java.lang.String view, java.lang.String anchor) | 
|  | void | appendLink(java.lang.StringBuffer buffer, java.lang.String name, java.lang.String view) | 
|  | boolean | exists(java.lang.String name) | 
|  | java.lang.String | getNaturalName(java.lang.String name) | 
|  | protected void | init() | 
|  | boolean | showCreate() | 
| Methods inherited from class | Name | 
|---|---|
| class org.radeox.engine.BaseRenderEngine | org.radeox.engine.BaseRenderEngine#render(java.io.Reader, org.radeox.api.engine.context.RenderContext), org.radeox.engine.BaseRenderEngine#render(java.lang.String, org.radeox.api.engine.context.RenderContext), org.radeox.engine.BaseRenderEngine#render(java.io.Writer, java.lang.String, org.radeox.api.engine.context.RenderContext), org.radeox.engine.BaseRenderEngine#getInitialRenderContext(), org.radeox.engine.BaseRenderEngine#getName(), org.radeox.engine.BaseRenderEngine#wait(long, int), org.radeox.engine.BaseRenderEngine#wait(long), org.radeox.engine.BaseRenderEngine#wait(), org.radeox.engine.BaseRenderEngine#equals(java.lang.Object), org.radeox.engine.BaseRenderEngine#toString(), org.radeox.engine.BaseRenderEngine#hashCode(), org.radeox.engine.BaseRenderEngine#getClass(), org.radeox.engine.BaseRenderEngine#notify(), org.radeox.engine.BaseRenderEngine#notifyAll() | 
| class java.lang.Object | java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() | 
Converts a property name into its natural language equivalent eg ('firstName' becomes 'First Name')
name -  The property name to convert