org.codehaus.groovy.tools.groovydoc
Class GroovyRootDocBuilder

java.lang.Object
  extended by org.codehaus.groovy.tools.groovydoc.GroovyRootDocBuilder

public class GroovyRootDocBuilder
extends java.lang.Object


Field Summary
private static char FS
           
private  java.util.List<LinkArgument> links
           
private  java.util.Properties properties
           
private  SimpleGroovyRootDoc rootDoc
           
private  java.lang.String[] sourcepaths
           
private  GroovyDocTool tool
           
 
Constructor Summary
GroovyRootDocBuilder(GroovyDocTool tool, java.lang.String[] sourcepaths, java.util.List<LinkArgument> links, java.util.Properties properties)
           
 
Method Summary
 void buildTree(java.util.List<java.lang.String> filenames)
           
private  void calcThenSetOverviewDescription(java.lang.String src)
           
private  java.lang.String calcThenSetPackageDescription(java.lang.String src, SimpleGroovyPackageDoc packageDoc)
           
private  void calcThenSetSummary(java.lang.String src, SimpleGroovyPackageDoc packageDoc)
           
 java.util.Map<java.lang.String,GroovyClassDoc> getClassDocsFromSingleSource(java.lang.String packagePath, java.lang.String file, java.lang.String src)
           
private  GroovyRecognizer getGroovyParser(java.lang.String input, SourceBuffer sourceBuffer)
           
private  JavaRecognizer getJavaParser(java.lang.String input, SourceBuffer sourceBuffer)
           
 GroovyRootDoc getRootDoc()
           
private  int indexOfTag(java.lang.String text, java.lang.String tag)
           
private  java.util.Map<java.lang.String,GroovyClassDoc> parseGroovy(java.lang.String packagePath, java.lang.String file, java.lang.String src)
           
private  java.util.Map<java.lang.String,GroovyClassDoc> parseJava(java.lang.String packagePath, java.lang.String file, java.lang.String src)
           
private  void processFile(java.lang.String filename, java.io.File srcFile)
           
private  void processHtmlPackage(java.lang.String src, SimpleGroovyPackageDoc packageDoc)
           
private  java.lang.String pruneTagFromEnd(java.lang.String description, java.lang.String tag)
           
private  java.lang.String pruneTagFromFront(java.lang.String description, java.lang.String tag)
           
private  java.lang.String scrubOffExcessiveTags(java.lang.String src)
           
private  void setOverview()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FS

private static final char FS
See Also:
Constant Field Values

links

private java.util.List<LinkArgument> links

tool

private final GroovyDocTool tool

sourcepaths

private final java.lang.String[] sourcepaths

rootDoc

private final SimpleGroovyRootDoc rootDoc

properties

private final java.util.Properties properties
Constructor Detail

GroovyRootDocBuilder

public GroovyRootDocBuilder(GroovyDocTool tool,
                            java.lang.String[] sourcepaths,
                            java.util.List<LinkArgument> links,
                            java.util.Properties properties)
Method Detail

getClassDocsFromSingleSource

public java.util.Map<java.lang.String,GroovyClassDoc> getClassDocsFromSingleSource(java.lang.String packagePath,
                                                                                   java.lang.String file,
                                                                                   java.lang.String src)
                                                                            throws antlr.RecognitionException,
                                                                                   antlr.TokenStreamException
Throws:
antlr.RecognitionException
antlr.TokenStreamException

parseJava

private java.util.Map<java.lang.String,GroovyClassDoc> parseJava(java.lang.String packagePath,
                                                                 java.lang.String file,
                                                                 java.lang.String src)
                                                          throws antlr.RecognitionException,
                                                                 antlr.TokenStreamException
Throws:
antlr.RecognitionException
antlr.TokenStreamException

parseGroovy

private java.util.Map<java.lang.String,GroovyClassDoc> parseGroovy(java.lang.String packagePath,
                                                                   java.lang.String file,
                                                                   java.lang.String src)
                                                            throws antlr.RecognitionException,
                                                                   antlr.TokenStreamException
Throws:
antlr.RecognitionException
antlr.TokenStreamException

getJavaParser

private JavaRecognizer getJavaParser(java.lang.String input,
                                     SourceBuffer sourceBuffer)

getGroovyParser

private GroovyRecognizer getGroovyParser(java.lang.String input,
                                         SourceBuffer sourceBuffer)

buildTree

public void buildTree(java.util.List<java.lang.String> filenames)
               throws java.io.IOException,
                      antlr.RecognitionException,
                      antlr.TokenStreamException
Throws:
java.io.IOException
antlr.RecognitionException
antlr.TokenStreamException

setOverview

private void setOverview()

processFile

private void processFile(java.lang.String filename,
                         java.io.File srcFile)
                  throws java.io.IOException
Throws:
java.io.IOException

processHtmlPackage

private void processHtmlPackage(java.lang.String src,
                                SimpleGroovyPackageDoc packageDoc)

calcThenSetSummary

private void calcThenSetSummary(java.lang.String src,
                                SimpleGroovyPackageDoc packageDoc)

calcThenSetPackageDescription

private java.lang.String calcThenSetPackageDescription(java.lang.String src,
                                                       SimpleGroovyPackageDoc packageDoc)

calcThenSetOverviewDescription

private void calcThenSetOverviewDescription(java.lang.String src)

scrubOffExcessiveTags

private java.lang.String scrubOffExcessiveTags(java.lang.String src)

pruneTagFromFront

private java.lang.String pruneTagFromFront(java.lang.String description,
                                           java.lang.String tag)

pruneTagFromEnd

private java.lang.String pruneTagFromEnd(java.lang.String description,
                                         java.lang.String tag)

indexOfTag

private int indexOfTag(java.lang.String text,
                       java.lang.String tag)

getRootDoc

public GroovyRootDoc getRootDoc()


Copyright © ${year} The Codehaus. All Rights Reserved.