# Package org.codehaus.groovy.tools.groovydoc

## Package org.codehaus.groovy.tools.groovydoc Description

GroovyDoc tool.

- Interface Summary
  Interface | Description
  --- | ---
  GroovyDocParserI | Parses a single source unit into Groovydoc class documentation objects.
  OutputTool | Receives rendered documentation output and supporting resource copies.
  ResourceManager | Provides character streams for documentation templates and related resources.

- Class Summary
  Class | Description
  --- | ---
  ArrayClassDocWrapper | A GroovyClassDoc decorator that wraps a component-type class doc for array-type representations.
  ClassTree | GROOVY-11942: builds the inheritance/extension trees rendered by the `overview-tree.html` and `package-tree.html` templates.
  ClassTree.Node | A node in an inheritance/extension tree.
  ClasspathResourceManager | Loads documentation resources from the classpath.
  ExternalGroovyClassDoc | Represents a class not in the codebase being processed.
  FileOutputTool | Writes generated documentation and copied resources to the file system.
  FileSystemResourceManager | Loads documentation resources from the local file system.
  GroovyDocTemplateEngine | Process Groovydoc templates.
  GroovyDocTool | Coordinates source parsing and template-driven rendering for GroovyDoc generation.
  GroovyDocWriter | Write GroovyDoc resources to destination.
  GroovyRootDocBuilder | Builds a SimpleGroovyRootDoc from source files by dispatching each file to either the Groovy AST visitor or the Java parser.
  GroovydocAnnotationUtils | Utilities shared between `GroovydocVisitor` (Groovy AST) and `GroovydocJavaVisitor` (JavaParser AST).
  LinkArgument | Represents a link pair (href, packages) with optional JPMS module.
  Main | Main CLI entry-point for `groovydoc`.
  MarkdownRenderer | GROOVY-11542: support for JEP 467 Markdown documentation comments (triple-slash `///} runs, captured by {@link org.apache.groovy.antlr.GroovydocVisitor`).
  MockOutputTool | In-memory OutputTool used by tests.
  PreLanguageRewriter | Post-process pass that retrofits syntax-highlighting classes onto bare `<pre>` blocks in generated HTML.
  SimpleGroovyAbstractableElementDoc | Base implementation for documented elements that can carry the `abstract` modifier.
  SimpleGroovyAnnotationRef | Default GroovyAnnotationRef implementation backed by parsed source text.
  SimpleGroovyClassDoc | Default GroovyClassDoc implementation for classes parsed from Groovy or Java source.
  SimpleGroovyConstructorDoc | Default GroovyConstructorDoc implementation.
  SimpleGroovyDoc | Base implementation of the GroovyDoc contract.
  SimpleGroovyExecutableMemberDoc | Base implementation for executable members such as methods and constructors.
  SimpleGroovyFieldDoc | Default GroovyFieldDoc implementation.
  SimpleGroovyMemberDoc | Base implementation for documented members declared within a class.
  SimpleGroovyMethodDoc | Default GroovyMethodDoc implementation.
  SimpleGroovyPackageDoc | Default GroovyPackageDoc implementation.
  SimpleGroovyParameter | Default GroovyParameter implementation.
  SimpleGroovyProgramElementDoc | Base implementation for documented program elements with modifiers, package ownership, and annotations.
  SimpleGroovyRootDoc | Default GroovyRootDoc implementation used to collect packages, classes, and lookup caches.
  SimpleGroovyTag | Stores info about GroovyDoc tags.
  SimpleGroovyType | Simple immutable GroovyType implementation backed by a type name string.