# Package org.codehaus.groovy.tools.groovydoc

package org.codehaus.groovy.tools.groovydoc

GroovyDoc tool.

- Related Packages
  Package
  Description
  org.codehaus.groovy.tools
  Command-line, compilation, and bootstrap utilities used by the Groovy tool chain.
  org.codehaus.groovy.tools.groovydoc.antlr4
  ANTLR4 grammar and lexer/parser support for Groovy documentation comment parsing.
  org.codehaus.groovy.tools.groovydoc.gstringTemplates
  GString template utilities for rendering generated Groovy documentation in various output formats.
  org.codehaus.groovy.tools.gse
  Groovy Script Engine (GSE) utilities.
  org.codehaus.groovy.tools.javac
  Joint-compilation support integrating Groovy compilation units with Java stub generation and javac execution.
  org.codehaus.groovy.tools.shell
  Groovy Shell implementation.
- Class
  Description
  ArrayClassDocWrapper
  A `GroovyClassDoc` decorator that wraps a component-type class doc for array-type representations.
  ClasspathResourceManager
  Loads documentation resources from the classpath.
  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.
  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.
  GroovydocAnnotationUtils
  Utilities shared between `GroovydocVisitor` (Groovy AST) and `GroovydocJavaVisitor` (JavaParser AST).
  GroovyDocParserI
  Parses a single source unit into Groovydoc class documentation objects.
  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.
  LinkArgument
  Represents a link pair (href, packages) with optional JPMS module.
  MarkdownRenderer
  GROOVY-11542: support for JEP 467 Markdown documentation comments (triple-slash `///` runs, captured by `GroovydocVisitor`).
  MockOutputTool
  In-memory `OutputTool` used by tests.
  OutputTool
  Receives rendered documentation output and supporting resource copies.
  PreLanguageRewriter
  Post-process pass that retrofits syntax-highlighting classes onto bare `<pre>` blocks in generated HTML.
  ResourceManager
  Provides character streams for documentation templates and related resources.
  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.