A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

addMacro(java.lang.Object) - Method in DocEngine
ALIAS - Property in DocEngine
ant - Property in DocPublisher
The AntBuilder instance to use
API_BASE_PATH - Property in DocEngine
API_CONTEXT_PATH - Property in DocEngine
apiDir - Property in DocPublisher
Directory containing the project's API documentation.
appendCreateLink(java.lang.StringBuffer, java.lang.String, java.lang.String) - Method in DocEngine
appendLink(java.lang.StringBuffer, java.lang.String, java.lang.String) - Method in DocEngine
asciidoc - Property in DocPublisher
asciidoc - Property in PublishGuide
AsciiDocEngine - Class in grails.doc.asciidoc
A DocEngine implementation that uses Asciidoctor to render pages
AsciiDocEngine() - Constructor in AsciiDocEngine
asciidoctor - Property in AsciiDocEngine
attributes - Property in AsciiDocEngine
authors - Property in DocPublisher
The authors of the documentation

B

BASE_DIR - Property in DocEngine
baseDirs - Property in GspTagSourceMacro
build(java.util.Map) - Method in PdfBuilder
Builds a PDF file from the manual's single.html file.
build(java.lang.String) - Method in SoftwareVersion

C

children - Property in UserGuideNode
cleanHtml - Property in PdfBuilder
compareTo(grails.doc.dropdown.Snapshot) - Method in Snapshot
compareTo(grails.doc.dropdown.SoftwareVersion) - Method in SoftwareVersion
composeSelectHtml() - Method in CreateReleasesDropdownTask
CONTEXT_PATH - Property in DocEngine
copyright - Property in DocPublisher
The copyright message
createDocument(java.lang.String) - Method in PdfBuilder
createPdf(java.lang.String, java.io.File, java.io.File) - Method in PdfBuilder
createPdfWithDocument(org.w3c.dom.Document, java.io.File, java.io.File) - Method in PdfBuilder
CreateReleasesDropdownTask - Class in grails.doc.dropdown
CreateReleasesDropdownTask() - Constructor in CreateReleasesDropdownTask
createXml(java.io.File, java.lang.String) - Method in PdfBuilder
css - Property in DocPublisher
The directory containing any CSS to use (will override defaults) *

D

debugPdf - Property in PdfBuilder
DocEngine - Class in grails.doc
A Radeox Wiki engine for generating documentation using a confluence style syntax.
DocEngine(org.radeox.api.engine.context.InitialRenderContext) - Constructor in DocEngine
DocPublisher - Class in grails.doc
Coordinated the DocEngine the produce documentation based on the gdoc format.
DocPublisher(java.io.File, java.io.File, java.lang.Object) - Constructor in DocPublisher
DocPublisherTask - Class in grails.doc.ant
An ant task for using the DocEngine.
DocPublisherTask() - Constructor in DocPublisherTask

E

encodeAsHtml(java.lang.String) - Method in StringEscapeCategory
encodeAsUrlFragment(java.lang.String) - Method in StringEscapeCategory
encodeAsUrlPath(java.lang.String) - Method in StringEscapeCategory
encoding - Property in DocPublisher
The encoding to use (default is UTF-8)
engineProperties - Property in DocEngine
engineProperties - Property in DocPublisher
Properties used to configure the DocEngine
execute() - Method in DocPublisherTask
execute(java.io.Writer, org.radeox.macro.parameter.MacroParameter) - Method in GspTagSourceMacro
execute(java.io.Writer, org.radeox.macro.parameter.MacroParameter) - Method in HiddenMacro
exists(java.lang.String) - Method in DocEngine
exists(java.lang.Object) - Method in FileResourceChecker
EXTERNAL_DOCS - Property in DocEngine
extractTagClosureSource(java.lang.String, java.lang.String) - Method in GspTagSourceMacro
Extracts the Closure source code for a given tag name.

F

file - Property in UserGuideNode
The location (including filename) of the node, relatively to the root of the gdoc source directory.
FileResourceChecker - Class in grails.doc.internal
Simple class that checks whether a path relative to a base directory exists or not.
FileResourceChecker(java.io.File) - Constructor in FileResourceChecker
fonts - Property in DocPublisher
The directory containing any fonts to use (will override defaults) *
footer - Property in DocPublisher
The footer to include

G

generateToc(java.lang.Object) - Method in LegacyTocStrategy
generateToc(java.lang.Object) - Method in YamlTocStrategy
getEngineProperties() - Method in DocPublisher
Returns the engine properties.
getMilestoneVersion() - Method in Snapshot
getName() - Method in GspTagSourceMacro
getName() - Method in HiddenMacro
getNaturalName(java.lang.String) - Method in DocEngine
getReleaseCandidateVersion() - Method in Snapshot
getWikiView(java.lang.String) - Method in LinkTestFilter
Returns the view of the wiki name that is shown to the user.
GspTagSourceMacro - Class in grails.doc.macros
GspTagSourceMacro(java.lang.Object) - Constructor in GspTagSourceMacro
guide - Property in CreateReleasesDropdownTask
guideDir - Property in MigrateLegacyDocs

H

handleMatch(java.lang.StringBuffer, org.radeox.regex.MatchResult, org.radeox.filter.context.FilterContext) - Method in HeaderFilter
handleMatch(java.lang.StringBuffer, org.radeox.regex.MatchResult, org.radeox.filter.context.FilterContext) - Method in LinkTestFilter
handleMatch(java.lang.StringBuffer, org.radeox.regex.MatchResult, org.radeox.filter.context.FilterContext) - Method in ListFilter
HeaderFilter - Class in grails.doc.filters
Authors:
Graeme Rocher
HeaderFilter() - Constructor in HeaderFilter
HiddenMacro - Class in grails.doc.macros
HiddenMacro() - Constructor in HiddenMacro

I

images - Property in DocPublisher
The directory containing any images to use (will override defaults) *
index - Property in CreateReleasesDropdownTask
init() - Method in DocEngine
initialize() - Method in DocPublisher
isBuildSnapshot() - Method in Snapshot
isMilestone() - Method in Snapshot
isReleaseCandidate() - Method in Snapshot
isSnapshot() - Method in SoftwareVersion

J

js - Property in DocPublisher
The directory containing any Javascript to use (will override defaults) *

K

L

language - Property in DocPublisher
The language we're generating for (gets its own sub-directory).
language - Property in PublishGuide
language - Property in PublishPdf
LegacyDocMigrator - Class in grails.doc
LegacyDocMigrator(java.io.File, java.io.File, java.lang.Object) - Constructor in LegacyDocMigrator
LegacyTocStrategy - Class in grails.doc.internal
LegacyTocStrategy() - Constructor in LegacyTocStrategy
license - Property in DocPublisher
The documentation license
LinkTestFilter - Class in grails.doc.filters
Authors:
Graeme Rocher
LinkTestFilter() - Constructor in LinkTestFilter
ListFilter - Class in grails.doc.filters
Authors:
Graeme Rocher
ListFilter() - Constructor in ListFilter
load(java.io.Reader) - Method in YamlTocStrategy
logo - Property in DocPublisher
HTML markup that renders the left logo

M

macros - Property in PublishGuide
major - Property in SoftwareVersion
migrate() - Method in LegacyDocMigrator
migrate() - Method in MigrateLegacyDocs
MigrateLegacyDocs - Class in grails.doc.gradle
Gradle task for migrating Grails 1.x gdocs to the newer Grails 2.x form with a YAML-based table of contents.
MigrateLegacyDocs() - Constructor in MigrateLegacyDocs
minor - Property in SoftwareVersion
modifyHtmlAndAddReleasesDropdown() - Method in CreateReleasesDropdownTask

N

name - Property in UserGuideNode
The identifier for this node.
nameCache - Property in DocEngine
Converts a property name into its natural language equivalent eg ('firstName' becomes 'First Name')

O

output - Property in DocPublisher
outputDir - Property in MigrateLegacyDocs
outputDirectory - Property in PublishPdf

P

parent - Property in UserGuideNode
parseSoftwareVersions(java.lang.Object) - Method in CreateReleasesDropdownTask
patch - Property in SoftwareVersion
PdfBuilder - Class in grails.doc
PdfBuilder() - Constructor in PdfBuilder
pdfCss() - Method in PdfBuilder
pdfName - Property in PublishPdf
PdfPublisher - Class in grails.doc
PdfPublisher() - Constructor in PdfPublisher
properties - Property in PublishGuide
propertiesFile - Property in DocPublisher
The properties fie to populate the engine properties from
propertiesFiles - Property in PublishGuide
publish() - Method in DocPublisher
publish() - Method in PublishPdf
publisher - Property in DocPublisherTask
PublishGuide - Class in grails.doc.gradle
Gradle task for generating a gdoc-based HTML user guide.
PublishGuide() - Constructor in PublishGuide
PublishPdf - Class in grails.doc.gradle
Gradle task for generating a gdoc-based PDF user guide.
PublishPdf() - Constructor in PublishPdf
publishPdfFromHtml(java.io.File, java.lang.String, java.lang.String) - Method in PdfPublisher

Q

R

registerMacro(java.lang.Object) - Method in DocPublisher
Registers a custom Radeox macro.
removeCssLinks(java.lang.String) - Method in PdfBuilder
render(java.lang.String, org.radeox.api.engine.context.RenderContext) - Method in AsciiDocEngine
RESOURCES_CONTEXT_PATH - Property in DocEngine
resourcesDir - Property in MigrateLegacyDocs
resourcesDir - Property in PublishGuide

S

setCssDir(java.io.File) - Method in DocPublisherTask
The directory of the css templates (optional)
setDest(java.io.File) - Method in DocPublisherTask
The documentation publishing destination
setEncoding(java.lang.String) - Method in DocPublisherTask
The encoding to use (default is UTF-8)
setEngineProperties(java.util.Properties) - Method in DocPublisher
Sets the engine properties.
setImagesDir(java.io.File) - Method in DocPublisherTask
The directory of the images (optional)
setProperties(java.util.Properties) - Method in DocPublisherTask
A properties containing the title, author etc.
setSrc(java.io.File) - Method in DocPublisherTask
The documentation source location
setStyleDir(java.io.File) - Method in DocPublisherTask
The directory of the style templates (optional)
setWorkDir(java.io.File) - Method in DocPublisherTask
The temporary directory to use (optional)
showCreate() - Method in DocEngine
slug - Property in CreateReleasesDropdownTask
Snapshot - Class in grails.doc.dropdown
Snapshot(java.lang.String) - Constructor in Snapshot
snapshot - Property in SoftwareVersion
SoftwareVersion - Class in grails.doc.dropdown
SoftwareVersion() - Constructor in SoftwareVersion
SOURCE_FILE - Property in DocEngine
sourceDir - Property in PublishGuide
sourceRepo - Property in DocPublisher
The source repository
sourceRepo - Property in PublishGuide
sponsorLogo - Property in DocPublisher
HTML markup that renders the right logo
src - Property in DocPublisher
The source directory of the documentation
StringEscapeCategory - Class in grails.doc.internal
style - Property in DocPublisher
The directory cotnaining any templates to use (will override defaults) *
subtitle - Property in DocPublisher
The subtitle of the documentation

T

target - Property in DocPublisher
The target directory to publish to
targetDir - Property in PublishGuide
title - Property in DocPublisher
The title of the documentation
title - Property in UserGuideNode
The node title, as displayed in the generated user guide.
TOC_FILENAME - Property in DocPublisher
toString() - Method in SoftwareVersion
translators - Property in DocPublisher
The translators of the documentation (if any)

U

UserGuideNode - Class in grails.doc.internal
UserGuideNode() - Constructor in UserGuideNode

V

verifyToc(java.io.File, java.lang.Object, java.lang.Object) - Method in DocPublisher
Checks the table of contents (a tree of UserGuideNodes) for duplicate section/alias names and invalid file paths.
version - Property in CreateReleasesDropdownTask
version - Property in DocPublisher
The version of the documentation
versionText - Property in SoftwareVersion

W

workDir - Property in DocPublisher
The temporary work directory
workDir - Property in PublishGuide
writeChapter(java.lang.Object, groovy.text.Template, groovy.text.Template, java.io.File, java.lang.String, java.lang.Object, java.lang.Object) - Method in DocPublisher
writePage(java.lang.Object, groovy.text.Template, groovy.text.Template, java.io.File, java.lang.String, java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object) - Method in DocPublisher

X

Y

YamlTocStrategy - Class in grails.doc.internal
Class representing a Grails user guide table of contents defined in YAML.
YamlTocStrategy(java.lang.Object, java.lang.String) - Constructor in YamlTocStrategy

Z

_

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _