GrammarScope  4.0.0
Classes | Public Member Functions | Static Public Member Functions | Static Package Functions | Static Package Attributes | Static Private Member Functions | Static Private Attributes | List of all members
grammarscope.generator.data.Doclet Class Reference
Collaboration diagram for grammarscope.generator.data.Doclet:
Collaboration graph
[legend]

Classes

interface  IProcessor
 
class  NoOpProcessor
 
enum  OutputMode
 

Public Member Functions

 Doclet () throws SecurityException, IllegalArgumentException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException
 

Static Public Member Functions

static boolean start (final RootDoc thisRootDoc) throws FileNotFoundException, SecurityException, IllegalArgumentException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException
 
static int optionLength (final String option)
 
static boolean validOptions (final String theseOptions[][], final DocErrorReporter thisReporter)
 
static void main (final String[] theseArgs0)
 

Static Package Functions

static void processEntry (final String thisName, final String thisDescription, final String[][] theseCodedExamples, final PrintWriter thisPrintWriter, final IProcessor thisProcessor) throws IllegalArgumentException, SecurityException, IllegalAccessException, InvocationTargetException, NoSuchMethodException
 
static String toStringArray (final String[] theseStrings, final boolean quote)
 
static String toStringArray (final String[][] theseStrings)
 
static String toStringArray1 (final String[][] theseStrings)
 

Static Package Attributes

static Map< String, GrammaticalRelation > theNameToRelationMap
 
static Map< GrammaticalRelation, String > theRelationToNameMap
 

Static Private Member Functions

static void makeMaps (final String thisClass)
 
static boolean process (final ClassDoc thisClassDoc, final String thisSource, final String thisDestination, final PrintWriter thisPrintWriter, final IProcessor thisProcessor) throws IllegalArgumentException, SecurityException, IllegalAccessException, InvocationTargetException, NoSuchMethodException
 
static String parseComment (final String thisComment0, final List< String[]> thisCodedExampleList)
 
static void readOptions (final String[][] theseOptions)
 

Static Private Attributes

static String theOutputFile
 
static String theOutputClass
 
static OutputMode theMode = OutputMode.MODEL
 

Detailed Description

Doclet (requires tweaked GrammaticalRelation class in the path)

Author
Bernard Bou

Constructor & Destructor Documentation

◆ Doclet()

grammarscope.generator.data.Doclet.Doclet ( ) throws SecurityException, IllegalArgumentException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException

Constructor

Exceptions
SecurityExceptionexception
IllegalArgumentExceptionexception
InstantiationExceptionexception
IllegalAccessExceptionexception
NoSuchMethodExceptionexception
InvocationTargetExceptionexception
NoSuchFieldExceptionexception

Member Function Documentation

◆ main()

static void grammarscope.generator.data.Doclet.main ( final String[]  theseArgs0)
static

Main entry point

Parameters
theseArgs0save arguments as javadoc

◆ makeMaps()

static void grammarscope.generator.data.Doclet.makeMaps ( final String  thisClass)
staticprivate

Make maps

Parameters
thisClassclass containing instance as static member

◆ optionLength()

static int grammarscope.generator.data.Doclet.optionLength ( final String  option)
static

◆ parseComment()

static String grammarscope.generator.data.Doclet.parseComment ( final String  thisComment0,
final List< String[]>  thisCodedExampleList 
)
staticprivate

Parse comment

Parameters
thisComment0comment
thisCodedExampleListcoded exaple list
Returns
description

◆ process()

static boolean grammarscope.generator.data.Doclet.process ( final ClassDoc  thisClassDoc,
final String  thisSource,
final String  thisDestination,
final PrintWriter  thisPrintWriter,
final IProcessor  thisProcessor 
) throws IllegalArgumentException, SecurityException, IllegalAccessException, InvocationTargetException, NoSuchMethodException
staticprivate

Process specified source file

Parameters
thisClassDocclass doc to process
thisSourcesource
thisDestinationdestination
thisPrintWriterprint writer for output
thisProcessorprocessor
Returns
true if processed without error
Exceptions
IllegalArgumentExceptionexception
SecurityExceptionexception
IllegalAccessExceptionexception
InvocationTargetExceptionexception
NoSuchMethodExceptionexception

◆ processEntry()

static void grammarscope.generator.data.Doclet.processEntry ( final String  thisName,
final String  thisDescription,
final String  theseCodedExamples[][],
final PrintWriter  thisPrintWriter,
final IProcessor  thisProcessor 
) throws IllegalArgumentException, SecurityException, IllegalAccessException, InvocationTargetException, NoSuchMethodException
staticpackage

Print entry

Parameters
thisNamename
thisDescriptiondescription
theseCodedExamplesarray of (example,code) pairs
thisPrintWriterprintwriter
thisProcessorprocessor
Exceptions
IllegalArgumentExceptionexception
SecurityExceptionexception
IllegalAccessExceptionexception
InvocationTargetExceptionexception
NoSuchMethodExceptionexception

◆ readOptions()

static void grammarscope.generator.data.Doclet.readOptions ( final String  theseOptions[][])
staticprivate

◆ start()

static boolean grammarscope.generator.data.Doclet.start ( final RootDoc  thisRootDoc) throws FileNotFoundException, SecurityException, IllegalArgumentException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException
static

Start

Parameters
thisRootDocroot doc
Returns
true if processed without error
Exceptions
FileNotFoundExceptionexception
SecurityExceptionexception
IllegalArgumentExceptionexception
InstantiationExceptionexception
IllegalAccessExceptionexception
NoSuchMethodExceptionexception
InvocationTargetExceptionexception
NoSuchFieldExceptionexception

◆ toStringArray() [1/2]

static String grammarscope.generator.data.Doclet.toStringArray ( final String[]  theseStrings,
final boolean  quote 
)
staticpackage

◆ toStringArray() [2/2]

static String grammarscope.generator.data.Doclet.toStringArray ( final String  theseStrings[][])
staticpackage

◆ toStringArray1()

static String grammarscope.generator.data.Doclet.toStringArray1 ( final String  theseStrings[][])
staticpackage

◆ validOptions()

static boolean grammarscope.generator.data.Doclet.validOptions ( final String  theseOptions[][],
final DocErrorReporter  thisReporter 
)
static

Member Data Documentation

◆ theMode

OutputMode grammarscope.generator.data.Doclet.theMode = OutputMode.MODEL
staticprivate

◆ theNameToRelationMap

Map<String, GrammaticalRelation> grammarscope.generator.data.Doclet.theNameToRelationMap
staticpackage

◆ theOutputClass

String grammarscope.generator.data.Doclet.theOutputClass
staticprivate

Output class

◆ theOutputFile

String grammarscope.generator.data.Doclet.theOutputFile
staticprivate

Output file

◆ theRelationToNameMap

Map<GrammaticalRelation, String> grammarscope.generator.data.Doclet.theRelationToNameMap
staticpackage

The documentation for this class was generated from the following file: