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(def) - Method in DocEngine
AntLogAdapter - Class in grails.doc.ant
AntLogAdapter(def, def) - Constructor in AntLogAdapter
appendCreateLink(StringBuffer, String, String) - Method in DocEngine
appendLink(StringBuffer, String, String) - Method in DocEngine
AsciiDocEngine - Class in grails.doc.asciidoc
A DocEngine implementation that uses Asciidoctor to render pages

B

BlockQuoteFilter - Class in grails.doc
BlockQuoteFilter() - Constructor in BlockQuoteFilter
BoldFilter - Class in grails.doc
BoldFilter() - Constructor in BoldFilter
build(Map) - Method in PdfBuilder
Builds a PDF file from the manual's single.html file.

C

CodeFilter - Class in grails.doc
CodeFilter() - Constructor in CodeFilter
createDocument(String) - Method in PdfBuilder
createPdf(String, File, File) - Method in PdfBuilder
createPdfWithDocument(Document, File, File) - Method in PdfBuilder
createXml(File, String) - Method in PdfBuilder

D

debug(String) - Method in AntLogAdapter
DocEngine - Class in grails.doc
A Radeox Wiki engine for generating documentation using a confluence style syntax.
DocEngine(InitialRenderContext) - Constructor in DocEngine
DocPublisher - Class in grails.doc
Coordinated the DocEngine the produce documentation based on the gdoc format.
DocPublisher(File, File, def) - Constructor in DocPublisher
DocPublisherTask - Class in grails.doc.ant
An ant task for using the DocEngine.

E

encodeAsHtml(String) - Method in StringEscapeCategory
encodeAsUrlFragment(String) - Method in StringEscapeCategory
encodeAsUrlPath(String) - Method in StringEscapeCategory
error(String) - Method in AntLogAdapter
execute() - Method in DocPublisherTask
execute(Writer, MacroParameter) - Method in GspTagSourceMacro
execute(Writer, MacroParameter) - Method in HiddenMacro
execute(Writer, MacroParameter) - Method in NoteMacro
execute(Writer, MacroParameter) - Method in WarningMacro
exists(String) - Method in DocEngine
exists(def) - Method in FileResourceChecker
extractTagClosureSource(String, String) - Method in GspTagSourceMacro
Extracts the Closure source code for a given tag name.

F

FileResourceChecker - Class in grails.doc.internal
Simple class that checks whether a path relative to a base directory exists or not.
FileResourceChecker(File) - Constructor in FileResourceChecker

G

generateToc(def) - Method in LegacyTocStrategy
generateToc(def) - Method in YamlTocStrategy
getEngineProperties() - Method in DocPublisher
Returns the engine properties.
getName() - Method in GspTagSourceMacro
getName() - Method in HiddenMacro
getName() - Method in NoteMacro
getName() - Method in WarningMacro
getNaturalName(String) - Method in DocEngine
getWikiView(String) - Method in LinkTestFilter
Returns the view of the wiki name that is shown to the user.
GspTagSourceMacro - Class in grails.doc.macros
GspTagSourceMacro(def) - Constructor in GspTagSourceMacro

H

handleMatch(StringBuffer, MatchResult, FilterContext) - Method in BlockQuoteFilter
handleMatch(StringBuffer, MatchResult, FilterContext) - Method in BoldFilter
handleMatch(StringBuffer, MatchResult, FilterContext) - Method in CodeFilter
handleMatch(StringBuffer, MatchResult, FilterContext) - Method in HeaderFilter
handleMatch(StringBuffer, MatchResult, FilterContext) - Method in ImageFilter
handleMatch(StringBuffer, MatchResult, FilterContext) - Method in ItalicFilter
handleMatch(StringBuffer, MatchResult, FilterContext) - Method in LinkTestFilter
handleMatch(StringBuffer, MatchResult, FilterContext) - Method in ListFilter
handleMatch(StringBuffer, MatchResult, FilterContext) - Method in TextileLinkFilter
HeaderFilter - Class in grails.doc.filters
@author Graeme Rocher
HeaderFilter() - Constructor in HeaderFilter
HiddenMacro - Class in grails.doc.macros

I

ImageFilter - Class in grails.doc
ImageFilter() - Constructor in ImageFilter
info(String) - Method in AntLogAdapter
init() - Method in DocEngine
initialize() - Method in DocPublisher
ItalicFilter - Class in grails.doc
ItalicFilter() - Constructor in ItalicFilter

J

K

L

LegacyDocMigrator - Class in grails.doc
LegacyDocMigrator(File, File, def) - Constructor in LegacyDocMigrator
LegacyTocStrategy - Class in grails.doc.internal
LinkTestFilter - Class in grails.doc.filters
@author Graeme Rocher
LinkTestFilter() - Constructor in LinkTestFilter
ListFilter - Class in grails.doc.filters
@author Graeme Rocher
load(Reader) - Method in YamlTocStrategy

M

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.

N

NoteMacro - Class in grails.doc

O

P

PdfBuilder - Class in grails.doc
pdfCss() - Method in PdfBuilder
PdfPublisher - Class in grails.doc
publish() - Method in DocPublisher
publish() - Method in PublishPdf
PublishGuide - Class in grails.doc.gradle
Gradle task for generating a gdoc-based HTML user guide.
publishGuide() - Method in PublishGuide
PublishPdf - Class in grails.doc.gradle
Gradle task for generating a gdoc-based PDF user guide.
publishPdfFromHtml(File, String, String) - Method in PdfPublisher

Q

R

registerMacro(def) - Method in DocPublisher
Registers a custom Radeox macro.
removeCssLinks(String) - Method in PdfBuilder
render(String, RenderContext) - Method in AsciiDocEngine

S

setCssDir(File) - Method in DocPublisherTask
The directory of the css templates (optional)
setDest(File) - Method in DocPublisherTask
The documentation publishing destination
setEncoding(String) - Method in DocPublisherTask
The encoding to use (default is UTF-8)
setEngineProperties(Properties) - Method in DocPublisher
Sets the engine properties.
setImagesDir(File) - Method in DocPublisherTask
The directory of the images (optional)
setProperties(Properties) - Method in DocPublisherTask
A properties containing the title, author etc.
setSrc(File) - Method in DocPublisherTask
The documentation source location
setStyleDir(File) - Method in DocPublisherTask
The directory of the style templates (optional)
setWorkDir(File) - Method in DocPublisherTask
The temporary directory to use (optional)
showCreate() - Method in DocEngine
StringEscapeCategory - Class in grails.doc.internal

T

TextileLinkFilter - Class in grails.doc
TextileLinkFilter() - Constructor in TextileLinkFilter

U

UserGuideNode - Class in grails.doc.internal

V

verifyToc(File, def, def) - Method in DocPublisher
Checks the table of contents (a tree of UserGuideNodes) for duplicate section/alias names and invalid file paths.

W

warn(String) - Method in AntLogAdapter
WarningMacro - Class in grails.doc
writeChapter(def, Template, Template, File, String, def, def) - Method in DocPublisher
writePage(def, Template, Template, File, String, String, def, def, def) - Method in DocPublisher

X

Y

YamlTocStrategy - Class in grails.doc.internal
Class representing a Grails user guide table of contents defined in YAML.
YamlTocStrategy(def, 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 _