com.combex.e.edoc
Class DocSaver

java.lang.Object
  |
  +--com.sun.javadoc.Doclet
        |
        +--com.combex.e.edoc.DocSaver

public class DocSaver

extends com.sun.javadoc.Doclet

Untamed:

Author:

Mark S. Miller

Field Summary

private static AstroBuilder	B
private static AstroTag	CLASS
private static AstroTag	COMMENT
private static AstroTag	INTERFACE
private static AstroTag	METHOD
private static AstroTag	METHODS
private File	myDestDir
private static AstroTag	NAME
private static AstroTag	STATICS
private static AstroTag	TAG

Constructor Summary

DocSaver(File destDir)
Enabled:

Method Summary

Astro	classInfo(com.sun.javadoc.ClassDoc classDoc, String fqn, Term optSafeJ) Enabled:
Astro	commentInfo(com.sun.javadoc.Doc doc) Enabled:
Object	ctorInfo(Object args, com.sun.javadoc.ConstructorDoc ctorDoc, Term optSafeJ) Enabled: XXX Security Alert: The deprecated 'new' constructor is not described.
Object	fieldInfo(Object args, com.sun.javadoc.FieldDoc fieldDoc, Term optSafeJ) Enabled:
(package private) static String	fullyQualifiedName(com.sun.javadoc.ClassDoc classDoc) Unlike the doclet API, in our fully qualified names, nested classes are separated by "$", not ".".
private static File	GetOptDestDir(String[][] options, com.sun.javadoc.DocErrorReporter reporter)
private Object	memberInfo(Object args, com.sun.javadoc.MemberDoc memberDoc, String typedVerb, Term optSafeJ)
Object	methodInfo(Object args, com.sun.javadoc.MethodDoc methodDoc, Term optSafeJ) Enabled:
Astro	methodsInfo(com.sun.javadoc.ClassDoc classDoc, boolean isStatic, Term optSafeJ) Enabled:
static int	optionLength(String optionName) Enabled:
void	saveClass(com.sun.javadoc.ClassDoc classDoc) Enabled:
void	saveRoot(com.sun.javadoc.RootDoc rootDoc) Enabled:
static boolean	start(com.sun.javadoc.RootDoc rootDoc) Enabled:
Astro	tagInfo(com.sun.javadoc.Tag tag) Enabled:
Object	tagsInfo(Object argList, com.sun.javadoc.Tag[] tags) Enabled: Append onto 'argList' the tagInfo for each tag
Object	tagsInfo(com.sun.javadoc.Tag[] tags) Enabled: the list of tagInfo for each tag
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter reporter) Enabled:

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

B

private static final AstroBuilder B

CLASS

private static final AstroTag CLASS

INTERFACE

private static final AstroTag INTERFACE

STATICS

private static final AstroTag STATICS

METHODS

private static final AstroTag METHODS

METHOD

private static final AstroTag METHOD

NAME

private static final AstroTag NAME

COMMENT

private static final AstroTag COMMENT

TAG

private static final AstroTag TAG

myDestDir

private final File myDestDir

Constructor Detail

DocSaver

public DocSaver(File destDir)

Enabled:

Method Detail

optionLength

public static int optionLength(String optionName)

Enabled:

GetOptDestDir

private static File GetOptDestDir(String[][] options,
                                  com.sun.javadoc.DocErrorReporter reporter)

validOptions

public static boolean validOptions(String[][] options,
                                   com.sun.javadoc.DocErrorReporter reporter)

Enabled:

start

public static boolean start(com.sun.javadoc.RootDoc rootDoc)

Enabled:

saveRoot

public void saveRoot(com.sun.javadoc.RootDoc rootDoc)
              throws IOException

Enabled:

IOException

fullyQualifiedName

static String fullyQualifiedName(com.sun.javadoc.ClassDoc classDoc)

Unlike the doclet API, in our fully qualified names, nested classes are separated by "$", not ".".

saveClass

public void saveClass(com.sun.javadoc.ClassDoc classDoc)
               throws IOException

Enabled:

IOException

tagInfo

public Astro tagInfo(com.sun.javadoc.Tag tag)

Enabled:

tagsInfo

public Object tagsInfo(Object argList,
                       com.sun.javadoc.Tag[] tags)

Enabled: Append onto 'argList' the tagInfo for each tag

tagsInfo

public Object tagsInfo(com.sun.javadoc.Tag[] tags)

Enabled: the list of tagInfo for each tag

commentInfo

public Astro commentInfo(com.sun.javadoc.Doc doc)

Enabled:

classInfo

public Astro classInfo(com.sun.javadoc.ClassDoc classDoc,
                       String fqn,
                       Term optSafeJ)

Enabled:

methodsInfo

public Astro methodsInfo(com.sun.javadoc.ClassDoc classDoc,
                         boolean isStatic,
                         Term optSafeJ)

Enabled:

ctorInfo

public Object ctorInfo(Object args,
                       com.sun.javadoc.ConstructorDoc ctorDoc,
                       Term optSafeJ)

Enabled: XXX Security Alert: The deprecated 'new' constructor is not described.

fieldInfo

public Object fieldInfo(Object args,
                        com.sun.javadoc.FieldDoc fieldDoc,
                        Term optSafeJ)

Enabled:

methodInfo

public Object methodInfo(Object args,
                         com.sun.javadoc.MethodDoc methodDoc,
                         Term optSafeJ)

Enabled:

memberInfo

private Object memberInfo(Object args,
                          com.sun.javadoc.MemberDoc memberDoc,
                          String typedVerb,
                          Term optSafeJ)