Package org.codehaus.groovy.tools.groovydoc
package org.codehaus.groovy.tools.groovydoc
GroovyDoc tool.
-
ClassDescriptionA
GroovyClassDocdecorator that wraps a component-type class doc for array-type representations.Loads documentation resources from the classpath.GROOVY-11942: builds the inheritance/extension trees rendered by theoverview-tree.htmlandpackage-tree.htmltemplates.A node in an inheritance/extension tree.Represents a class not in the codebase being processed.Writes generated documentation and copied resources to the file system.Loads documentation resources from the local file system.Utilities shared betweenGroovydocVisitor(Groovy AST) andGroovydocJavaVisitor(JavaParser AST).Parses a single source unit into Groovydoc class documentation objects.Process Groovydoc templates.Coordinates source parsing and template-driven rendering for GroovyDoc generation.Write GroovyDoc resources to destination.Builds aSimpleGroovyRootDocfrom source files by dispatching each file to either the Groovy AST visitor or the Java parser.Represents a link pair (href, packages) with optional JPMS module.GROOVY-11542: support for JEP 467 Markdown documentation comments (triple-slash///runs, captured byGroovydocVisitor).In-memoryOutputToolused by tests.Receives rendered documentation output and supporting resource copies.Post-process pass that retrofits syntax-highlighting classes onto bare<pre>blocks in generated HTML.Provides character streams for documentation templates and related resources.Base implementation for documented elements that can carry theabstractmodifier.DefaultGroovyAnnotationRefimplementation backed by parsed source text.DefaultGroovyClassDocimplementation for classes parsed from Groovy or Java source.DefaultGroovyConstructorDocimplementation.Base implementation of theGroovyDoccontract.Base implementation for executable members such as methods and constructors.DefaultGroovyFieldDocimplementation.Base implementation for documented members declared within a class.DefaultGroovyMethodDocimplementation.DefaultGroovyPackageDocimplementation.DefaultGroovyParameterimplementation.Base implementation for documented program elements with modifiers, package ownership, and annotations.DefaultGroovyRootDocimplementation used to collect packages, classes, and lookup caches.Stores info about GroovyDoc tags.Simple immutableGroovyTypeimplementation backed by a type name string.