|
| Doclet () throws SecurityException, IllegalArgumentException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException |
|
|
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 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 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) |
|
Doclet (requires tweaked GrammaticalRelation class in the path)
- Author
- Bernard Bou
◆ Doclet()
grammarscope.generator.data.Doclet.Doclet |
( |
| ) |
throws SecurityException, IllegalArgumentException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException |
Constructor
- Exceptions
-
SecurityException | exception |
IllegalArgumentException | exception |
InstantiationException | exception |
IllegalAccessException | exception |
NoSuchMethodException | exception |
InvocationTargetException | exception |
NoSuchFieldException | exception |
◆ main()
static void grammarscope.generator.data.Doclet.main |
( |
final String[] |
theseArgs0 | ) |
|
|
static |
Main entry point
- Parameters
-
theseArgs0 | save arguments as javadoc |
◆ makeMaps()
static void grammarscope.generator.data.Doclet.makeMaps |
( |
final String |
thisClass | ) |
|
|
staticprivate |
Make maps
- Parameters
-
thisClass | class 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
-
thisComment0 | comment |
thisCodedExampleList | coded 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
-
thisClassDoc | class doc to process |
thisSource | source |
thisDestination | destination |
thisPrintWriter | print writer for output |
thisProcessor | processor |
- Returns
- true if processed without error
- Exceptions
-
IllegalArgumentException | exception |
SecurityException | exception |
IllegalAccessException | exception |
InvocationTargetException | exception |
NoSuchMethodException | exception |
◆ 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
-
thisName | name |
thisDescription | description |
theseCodedExamples | array of (example,code) pairs |
thisPrintWriter | printwriter |
thisProcessor | processor |
- Exceptions
-
IllegalArgumentException | exception |
SecurityException | exception |
IllegalAccessException | exception |
InvocationTargetException | exception |
NoSuchMethodException | exception |
◆ 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
-
- Returns
- true if processed without error
- Exceptions
-
FileNotFoundException | exception |
SecurityException | exception |
IllegalArgumentException | exception |
InstantiationException | exception |
IllegalAccessException | exception |
NoSuchMethodException | exception |
InvocationTargetException | exception |
NoSuchFieldException | exception |
◆ 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 |
◆ theMode
◆ theNameToRelationMap
Map<String, GrammaticalRelation> grammarscope.generator.data.Doclet.theNameToRelationMap |
|
staticpackage |
◆ theOutputClass
String grammarscope.generator.data.Doclet.theOutputClass |
|
staticprivate |
◆ theOutputFile
String grammarscope.generator.data.Doclet.theOutputFile |
|
staticprivate |
◆ theRelationToNameMap
Map<GrammaticalRelation, String> grammarscope.generator.data.Doclet.theRelationToNameMap |
|
staticpackage |
The documentation for this class was generated from the following file:
- generator/src/main/java/grammarscope/generator/data/Doclet.java