Packete:
AsciiDoc
Klassen:
AsciiDoc.AsciiDoc
Hirachie:
java.lang.Object
com.sun.javadoc.Doclet
* Dies ist ein Doclet, das die Packete ausliest, *
* und sie zusammen mit den enthaltenden Klassen *
* und deren Methoden in eine Ascii-Datei *
* (Std.: "out.txt") ausgibt.
*
* Mögliche Optionen sind: *
*
- -noPackage
*
* - -noClass
*
* - -noSuperClass
*
* - -noFields
*
* - -noMethod
*
* - -noComment
*
* - -file 〈name〉
*
Felder:
public static java.io.PrintWriter
* Writer der die Ausgabedatei repraesentiert *
public static java.lang.String
* Name der Ausgabedatei *
public static boolean
* sollen Packte ausgegeben werden? *
public static boolean
* sollen Superklassen ausgegeben werden? *
public static boolean
* sollen Klassen ausgegeben werden? *
public static boolean
* sollen Variablen ausgegeben werden? *
public static boolean
* sollen Methoden ausgegeben werden? *
public static boolean
* sollen Kommentare ausgegeben werden? *
Methoden:
public static void packeteSchreiben()
* geht die Packete durch, schreibt ihre Namen in out *
* und ruft klassenSchreiben auf *
public static void superKlassenSchreiben(com.sun.javadoc.ClassDoc)
* sucht die Superklassen und schreibt die Hirachie *
public static void klassenSchreiben(java.util.Enumeration)
* geht die Enumeration durch, schreibt alle Klassen *
* in out und ruft eventuell jeweils fieldSchreiben *
* und methodenSchreiben auf *
public static void methodenSchreiben(com.sun.javadoc.MethodDoc[])
* prüft die Attribude der Methoden, die Rückgabewerte und *
* die Parameter und schreibt alles in out *
public static void fieldsSchreiben(com.sun.javadoc.FieldDoc[])
* prüft die Attribude der Variablen und schreibt alles in out *
public static void kommentarSchreiben(com.sun.javadoc.Doc,java.lang.String)
* schreibt wenn gewuenscht die Kommentare des übergebenen Objectes *
public static boolean start(com.sun.javadoc.RootDoc)
* die notwendige Start-Methode, von der alles startet *
* und die init, packteSammeln und packeteSchreiben aufruft *
public static int optionLength(java.lang.String)
* überprüft ob die angegeben Kommandozeilenoptionen die *
* die richtige Anzahl von Parametern haben *
public static java.lang.String readOptions(java.lang.String[][])
* liest die Parameter und verarbeitet den File-Parameter *
public static boolean readOptions(java.lang.String[][],java.lang.String)
* liest die Parameter und die Boolean-Parameter
*
* wird implizit aufgerufen *
public static boolean validOptions(java.lang.String[][],com.sun.javadoc.DocErrorReporter)
* überprüft die Anzahl der angegebenen -file Optionen
*
* wird implizit aufgerufen *