Package: org.codehaus.groovy.tools.groovydoc.antlr4

## [Java] Class GroovyDocParser

- org.codehaus.groovy.tools.groovydoc.antlr4.GroovyDocParser

- All Implemented Interfaces and Traits:
    GroovyDocParserI

      public class GroovyDocParser
      extends Object
      implements GroovyDocParserI

  Parses Groovy and Java source files and builds GroovyClassDoc maps. Groovy sources are processed via the Groovy compiler AST (GroovydocVisitor); Java sources via JavaParser (GroovydocJavaVisitor).

- - ### Constructor Summary

    Constructors
    Constructor and description
    `GroovyDocParser(List<LinkArgument> links, Properties properties)` Creates a parser with a default com.github.javaparser.JavaParser instance.
    `GroovyDocParser(com.github.javaparser.JavaParser javaParser, List<LinkArgument> links, Properties properties)` Creates a parser with the supplied com.github.javaparser.JavaParser instance.

  - ### Methods Summary

    Methods
    Type Params | Return Type | Name and description
    --- | --- | ---
    `` | `public Map<String, GroovyClassDoc>` | `getClassDocsFromSingleSource(String packagePath, String file, String src)` Parses one source unit and returns the classes discovered in it. Parameters: `packagePath` - the package path associated with the source `file` - the source file name `src` - the source text to parse Returns: a map of discovered class names to class documentation objects

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class Object` | `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### public GroovyDocParser(List<LinkArgument> links, Properties properties)

      Creates a parser with a default com.github.javaparser.JavaParser instance.

    - #### public GroovyDocParser(com.github.javaparser.JavaParser javaParser, List<LinkArgument> links, Properties properties)

      Creates a parser with the supplied com.github.javaparser.JavaParser instance.

      Since:
        6.0.0

  - ### Method Detail

    - #### public Map<String, GroovyClassDoc> getClassDocsFromSingleSource(String packagePath, String file, String src)

      Parses one source unit and returns the classes discovered in it.

      Parameters:
        `packagePath` - the package path associated with the source
        `file` - the source file name
        `src` - the source text to parse
      Returns:
        a map of discovered class names to class documentation objects