* * Also determine the length of the command line option. For example, * * for a option "-header" there will be a string argument associated, then the * * the length of option "-header" is two. But for option "-nohelp" no argument * * is needed so it's length is 1. * *
* ** * Also do the error checking on the options used. For example it is illegal to * * use "-helpfile" option when already "-nohelp" option is used. * *
* Felder: public java.lang.String * Argument for command line option "-header". * public java.lang.String * Argument for command line option "-footer". * public java.lang.String * Argument for command line option "-doctitle". * public java.lang.String * Argument for command line option "-windowtitle". * public java.lang.String * Argument for command line option "-bottom". * public java.lang.String * Argument for command line option "-helpfile". * public java.lang.String * Argument for command line option "-stylesheetfile". * public boolean * True if command line option "-nohelp" is used. Default value is false. * public boolean * True if command line option "-splitindex" is used. Default value is * * false. * public boolean * False if command line option "-noindex" is used. Default value is true. * public boolean * True if command line option "-use" is used. Default value is false. * public boolean * False if command line option "-notree" is used. Default value is true. * public boolean * True if command line option "-nodeprecated" is used. Default value is * * false. * public boolean * True if command line option "-nonavbar" is used. Default value is false. * public boolean * True if command line option "-overview" is used. Default value is false. * public boolean * This is true if option "-overview" is used or option "-overview" is not * * used and number of packages is more than one. * public boolean * This is true if option "-serialwarn" is used. Defualt value is false to * * supress excessive warnings about serial tag. * public java.lang.String * The META charset tag used for cross-platform viewing. * public static com.sun.tools.doclets.standard.MessageRetriever * Unique Resource Handler for this package. * public java.lang.String * First file to appear in the right-hand frame in the generated * * documentation. * Methoden: public void setSpecificDocletOptions(com.sun.javadoc.RootDoc) * Depending upon the command line options provided by the user, set * * configure the output generation environment. * public int specificDocletOptionLength(java.lang.String) * Check for doclet added options here. This works exactly like * * {@link com.sun.tools.doclets.Configuration#optionLength(String)}. This * * will return the length of the options which are added by "standard" * * doclet. * public boolean specificDocletValidOptions(java.lang.String[][],com.sun.javadoc.DocErrorReporter) * This checks for the validity of the options used by the user. This works * * exactly like * * {@link com.sun.tools.doclets.Configuration#validOptions(String[][], * * DocErrorReporter)}. This will validate the options added by the * * "standard" doclet. For example, this method will flag an error using * * the DocErrorReporter if user has used "-nohelp" and "-helpfile" option * * together. * protected void setTopFile(com.sun.javadoc.RootDoc) * Decide the page which will appear first in the right-hand frame. It will * * be "overview-summary.html" if "-overview" option is used or no * * "-overview" but the number of packages is more than one. It will be * * "package-summary.html" of the respective package if there is only one * * package to document. It will be a class page(first in the sorted order), * * if only classes are provided on the command line. * protected com.sun.javadoc.ClassDoc getValidClass(com.sun.javadoc.ClassDoc[]) protected boolean checkForDeprecation(com.sun.javadoc.RootDoc) protected void setCreateOverview() * Generate "overview.html" page if option "-overview" is used or number of * * packages is more than one. Sets {@link createoverview} field to true. * com.sun.tools.doclets.standard.Standard Hirachie: java.lang.Object * The class with "start" method, calls individual Writers. * Felder: Methoden: public static boolean start(com.sun.javadoc.RootDoc) * The "start" method as required by Javadoc. * public static com.sun.tools.doclets.standard.ConfigurationStandard configuration() * Return the configuration instance. Create if it doesn't exist. * * Override this method to use a different * * configuration. * protected void startGeneration(com.sun.javadoc.RootDoc) * Start the generation of files. Call generate methods in the individual * * writers, which will in turn genrate the documentation files. Call the * * TreeWriter generation first to ensure the Class Hierarchy is built * * first and then can be used in the later generation. * * For new format. * protected void generateClassFiles(com.sun.javadoc.RootDoc,com.sun.tools.doclets.standard.ClassTree) protected java.lang.String classFileName(com.sun.javadoc.ClassDoc) protected void generateClassCycle(com.sun.javadoc.ClassDoc[],com.sun.tools.doclets.standard.ClassTree,boolean) * Instantiate ClassWriter for each Class within the ClassDoc[] * * passed to it and generate Documentation for that. * public static int optionLength(java.lang.String) * Check for doclet added options here. * public static boolean validOptions(java.lang.String[][],com.sun.javadoc.DocErrorReporter) * Check that options have the correct arguments here. * ** * This method is not required and will default gracefully * * (to true) if absent. * *
*
* Printing option related error messages (using the provided *
* DocErrorReporter) is the responsibility of this method. *
public static void copyFile(java.io.File,java.io.File)
* Copy source file to destination file. *
protected void performCopy(java.lang.String,java.lang.String)
public static boolean isGeneratedDoc(com.sun.javadoc.Doc)
* Return true if the doc element is getting documented, depending upon *
* -nodeprecated option and @deprecated tag used. Return true if *
* -nodeprecated is not used or @deprecated tag is not used. *
com.sun.tools.doclets.standard.SerializedFormWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
com.sun.tools.doclets.standard.SubWriterHolderWriter
* Generate the Serialized Form Information Page. *
Felder:
Methoden:
public static void generate(com.sun.javadoc.RootDoc)
* Generate a serialized form page. *
public void generateSerializedFormFile(com.sun.javadoc.RootDoc)
* Generate the serialized form file. *
protected void generateContents(com.sun.javadoc.RootDoc)
* Generate the serialized form file contents. *
protected void printSerialMemberInfo(com.sun.javadoc.ClassDoc)
* Print all the serializable member information. *
protected void printMembers(com.sun.javadoc.ClassDoc)
* Print summary and detail information for the serial members in the *
* class. *
protected void printPackageName(java.lang.String)
* Print the package name in the table format. *
protected void printClassName(java.lang.String)
protected void tableHeader()
protected void tableFooter()
com.sun.tools.doclets.standard.AbstractTreeWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
* Abstract class to print the class hierarchy page for all the Classes. This *
* is sub-classed by {@link PackageTreeWriter} and {@link TreeWriter} to *
* generate the Package Tree and global Tree(for all the classes and packages) *
* pages. *
Felder:
final protected com.sun.tools.doclets.standard.ClassTree
* The class and interface tree built by using {@link ClassTree} *
Methoden:
protected void generateLevelInfo(com.sun.javadoc.ClassDoc,java.util.List)
* Generate each level of the class tree. For each sub-class or *
* sub-interface indents the next level information. *
* Recurses itself to generate subclasses info. *
* To iterate is human, to recurse is divine - L. Peter Deutsch. *
protected void generateTree(java.util.List,java.lang.String)
* Generate the heading for the tree depending upon tree type if it's a *
* Class Tree or Interface tree and also print the tree. *
protected void printExtendsImplements(com.sun.javadoc.ClassDoc,com.sun.javadoc.ClassDoc)
* Print the information regarding the classes which this class extends or *
* implements. *
protected void printPartialInfo(com.sun.javadoc.ClassDoc)
* Print information about the class kind, if it's a "class" or "interface". *
protected void printTreeHeading(java.lang.String)
* Print the heading for the tree. *
protected void navLinkTree()
* Highlight "Tree" word in the navigation bar, since this is the tree page. *
com.sun.tools.doclets.standard.AbstractPackageWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
* Abstract class to generate file for each package contents. Sub-classed to *
* generate specific formats Frame and Non-Frame Output by *
* {@link PackageIndexFrameWriter} and {@link PackageIndexFrameWriter} *
* respectively. *
Felder:
Methoden:
protected void generateClassListing()
protected void printPackageDescription()
protected void printPackageHeader(java.lang.String)
protected void printPackageFooter()
protected void generatePackageFile()
* Generate Individual Package File with Class/Interface/Exceptions and *
* Error Listing with the appropriate links. Calls the methods from the *
* sub-classes to generate the file contents. *
protected void navLinkPackage()
* Highlight "Package" in the navigation bar, as this is the package page. *
com.sun.tools.doclets.standard.PackageWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
com.sun.tools.doclets.standard.AbstractPackageWriter
* Class to generate file for each package contents in the right-hand *
* frame. This will list all the Class Kinds in the package. A click on any *
* class-kind will update the frame with the clicked class-kind page. *
Felder:
protected com.sun.javadoc.PackageDoc
* The prev package name in the alpha-order list. *
protected com.sun.javadoc.PackageDoc
* The next package name in the alpha-order list. *
Methoden:
public static void generate(com.sun.javadoc.PackageDoc,com.sun.javadoc.PackageDoc,com.sun.javadoc.PackageDoc)
* Generate a package summary page for the right-hand frame. Construct *
* the PackageFrameWriter object and then uses it generate the file. *
protected void generateClassListing()
* Generate class listing for all the classes in this package. Divide class *
* listing as per the class kind and generate separate listing for *
* Classes, Interfaces, Exceptions and Errors. *
protected void generateClassKindListing(com.sun.javadoc.ClassDoc[],java.lang.String)
* Generate specific class kind listing. Also add label to the listing. *
protected void printFirstRow(java.lang.String)
* Print the table heading for the class-listing. *
protected void printPackageComment()
* Print the package comment as specified in the "packages.html" file in *
* the source package directory. *
protected void printPackageDescription()
* Print the package description and the tag information from the *
* "packages.html" file. *
protected void printPackageHeader(java.lang.String)
* Print one line summary cooment for the package at the top of the page and *
* add link to the description which is generated at the end of the page. *
protected void printPackageFooter()
* Print the navigation bar links at the bottom also print the "-bottom" *
* if specified on the command line. *
protected void copyDocFiles(java.lang.String)
* Copy the "doc-files" directory contents from the source package directory *
* to the generated documentation directory. For example for a package *
* java.lang this method find out the source location of the package using *
* {@link SourcePath} and if "doc-files" directory is found in the source *
* directory structure, copy the entire directory, to the generated *
* documentation hierarchy. *
protected void navLinkClassUse()
* Print "Use" link for this pacakge in the navigation bar. *
protected void navLinkPrevious()
* Print "PREV PACKAGE" link in the navigation bar. *
protected void navLinkNext()
* Print "NEXT PACKAGE" link in the navigation bar. *
protected void navLinkTree()
* Print "Tree" link in the navigation bar. This will be link to the package *
* tree file. *
com.sun.tools.doclets.standard.MethodSubWriter
Hirachie:
java.lang.Object
com.sun.tools.doclets.standard.AbstractSubWriter
com.sun.tools.doclets.standard.ExecutableMemberSubWriter
Felder:
Methoden:
public com.sun.javadoc.ProgramElementDoc[] members(com.sun.javadoc.ClassDoc)
public void printSummaryLabel(com.sun.javadoc.ClassDoc)
public void printSummaryAnchor(com.sun.javadoc.ClassDoc)
public void printInheritedMembersSummary(com.sun.javadoc.ClassDoc)
protected void printInheritedMembersInfo(com.sun.javadoc.ClassDoc,java.util.List)
public void printInheritedSummaryAnchor(com.sun.javadoc.ClassDoc)
public void printInheritedSummaryLabel(com.sun.javadoc.ClassDoc)
protected void printSummaryType(com.sun.javadoc.ProgramElementDoc)
protected void printReturnTag(com.sun.javadoc.Tag[])
protected void printOverridden(com.sun.javadoc.ClassDoc,com.sun.javadoc.MethodDoc)
protected void printTags(com.sun.javadoc.ProgramElementDoc)
protected void printTagsFromTaggedMethod(com.sun.javadoc.MethodDoc)
* Print @param, @return, @throws and @see tags only. *
protected void printTagsInfoHeader()
protected void printTagsInfoFooter()
protected void printImplementsInfo(com.sun.javadoc.MethodDoc)
protected com.sun.javadoc.MethodDoc implementedMethod(com.sun.javadoc.ClassDoc[],com.sun.javadoc.MethodDoc)
protected void printSignature(com.sun.javadoc.ExecutableMemberDoc)
protected void printComment(com.sun.javadoc.ProgramElementDoc)
protected void printCommentFromCommentedMethod(com.sun.javadoc.MethodDoc)
public void printMembersSummary(com.sun.javadoc.ClassDoc)
protected void printReturnType(com.sun.javadoc.MethodDoc)
protected void printHeader(com.sun.javadoc.ClassDoc)
protected void printNavSummaryLink(com.sun.javadoc.ClassDoc,boolean)
protected void printNavDetailLink(boolean)
protected java.util.Map getInheritedMethodMapForClass(com.sun.javadoc.ClassDoc,java.util.List,java.util.Map,java.util.List)
protected java.util.Map getInheritedMethodMapForInterface(com.sun.javadoc.ClassDoc,java.util.List,java.util.Map,java.util.List)
protected void composeInheritedMethodMap(com.sun.javadoc.ClassDoc,java.util.List,java.util.Map,java.util.List)
protected boolean contains(java.util.List,com.sun.javadoc.MethodDoc)
* The simple search. Order `n'. *
com.sun.tools.doclets.standard.Extern
Hirachie:
java.lang.Object
* Process and manage "-link" and "-linkoffline" to external packages. The *
* options "-link" and "-linkoffline" both depend on the fact that Javadoc now *
* generates "package-list"(lists all the packages which are getting *
* documented) file in the current or the destination directory, while *
* generating the documentation. *
Felder:
Methoden:
public static com.sun.tools.doclets.standard.Extern findPackage(java.lang.String)
* Get the "Extern" object associated with this package name. *
public static boolean url(java.lang.String,java.lang.String,com.sun.javadoc.DocErrorReporter)
* Build the extern package list from given URL or the directory path. *
* Flag error if the "-link" or "-linkoffline" option is already used. *
public java.lang.String toString()
* String representation of "this" with packagename and the path. *
com.sun.tools.doclets.standard.AbstractPackageIndexWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
* Abstract class to generate the package index. The package index needs to be *
* generated in Frame and Non-Frame format. This will be sub-classed by to *
* generate frame-index as well as overview-index. *
Felder:
protected com.sun.javadoc.PackageDoc[]
* Array of Packages to be documented. *
Methoden:
protected void printNavigationBarHeader()
protected void printNavigationBarFooter()
protected void printOverviewHeader()
protected void printIndexHeader(java.lang.String)
protected void printIndexRow(com.sun.javadoc.PackageDoc)
protected void printIndexFooter()
protected void generatePackageIndexFile()
* Generate the contants in the package index file. Call appropriate *
* methods from the sub-class in order to generate Frame or Non *
* Frame format. *
protected void printOverview()
* Default to no overview, overwrite to add overview. *
protected void generateIndex()
* Generate the frame or non-frame package index. *
protected void printIndexContents(com.sun.javadoc.PackageDoc[],java.lang.String)
* Generate code for package index contents. Call appropriate methods from *
* the sub-classes. *
protected void printConfigurationTitle()
* Print the doctitle, if it is specified on the command line. *
protected void navLinkContents()
* Highlight "Overview" in the bold format, in the navigation bar as this *
* is the overview page. *
protected void printAllClassesPackagesLink()
* Do nothing. This will be overridden in PackageIndexFrameWriter. *
com.sun.tools.doclets.standard.PackageIndexWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
com.sun.tools.doclets.standard.AbstractPackageIndexWriter
* Generate the package index page "overview-summary.html" for the right-hand *
* frame. A click on the package name on this page will update the same frame *
* with the "pacakge-summary.html" file for the clicked package. *
Felder:
Methoden:
public static void generate(com.sun.javadoc.RootDoc)
* Generate the package index page for the right-hand frame. *
protected void printIndexRow(com.sun.javadoc.PackageDoc)
* Print each package in separate rows in the index table. Generate link *
* to each package. *
protected void generateIndex()
* Depending upon the grouping information and their titles, generate *
* separate table indices for each package group. *
protected void printOverviewHeader()
* Print the overview summary comment for this documentation. Print one line *
* summary at the top of the page and generate a link to the description, *
* which is generated at the end of this page. *
protected void printIndexHeader(java.lang.String)
* Print Html tags for the table for this package index. *
protected void printIndexFooter()
* Print Html closing tags for the table for this package index. *
protected void printOverviewComment()
* Print the overview comment as provided in the file specified by the *
* "-overview" option on the command line. *
protected void printOverview()
* Call {@link #printOverviewComment()} and then genrate the tag information *
* as provided in the file specified by the "-overview" option on the *
* command line. *
protected void printNavigationBarHeader()
* Print the header for navigation bar. Also print the "-title" specified *
* on command line, at the top of page. *
protected void printNavigationBarFooter()
* Print the footer fornavigation bar. Also print the "-bottom" specified *
* on command line, at the top of page. *
com.sun.tools.doclets.standard.PackageIndexFrameWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
com.sun.tools.doclets.standard.AbstractPackageIndexWriter
* Generate the package index for the left-hand frame in the generated output. *
* A click on the package name in this frame will update the page in the bottom *
* left hand frame with the listing of contents of the clicked package. *
Felder:
Methoden:
public static void generate()
* Generate the package index file named "overview-frame.html". *
protected void printIndexRow(com.sun.javadoc.PackageDoc)
* Print each package name on separate rows. *
protected void printNavigationBarHeader()
* Print the "-header" in bold format, at top of the page. There is *
* actually no navigation bar for this page. *
protected void printOverviewHeader()
* Do nothing as there is no overview information in this page. *
protected void printIndexHeader(java.lang.String)
* Print Html "table" tag for the package index format. *
protected void printIndexFooter()
* Print Html closing "table" tag at the end of the package index. *
protected void printAllClassesPackagesLink()
* Print "All Classes" link at the top of the left-hand frame page. *
protected void printNavigationBarFooter()
* Just print some space, since there is no navigation bar for this page. *
protected void printTableFooter()
* Print Html closing tags for the table for package index. *
protected void printTableHeader()
* Print Html tags for the table for package index. *
com.sun.tools.doclets.standard.DeprecatedAPIListBuilder
Hirachie:
java.lang.Object
* Build list of all the deprecated classes, constructors, fields and methods. *
Felder:
Methoden:
public java.util.List getDeprecatedClasses()
* Return the list of deprecated classes. *
public java.util.List getDeprecatedInterfaces()
* Return the list of deprecated interfaces. *
public java.util.List getDeprecatedErrors()
* Return the list of deprecated errors. *
public java.util.List getDeprecatedExceptions()
* Return the list of deprecated exceptions. *
public java.util.List getDeprecatedFields()
* Return the list of deprecated fields. *
public java.util.List getDeprecatedMethods()
* Return the list of deprecated methods. *
public java.util.List getDeprecatedConstructors()
* Return the list of deprecated constructors. *
com.sun.tools.doclets.standard.AllClassesFrameWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
* Generate the file with list of all the classes in this run. This page will be *
* used in the left-hand bottom frame, when "All Classes" link is clicked in *
* the left-hand top frame. The name of the generated file is *
* "allclasses-frame.html". *
Felder:
protected com.sun.tools.doclets.standard.IndexBuilder
* Index of all the classes. *
Methoden:
public static void generate(com.sun.tools.doclets.standard.IndexBuilder)
* Create AllClassesFrameWriter object. Then use it to generate the *
* "allclasses-frame.html" file. Generate the file in the current or the *
* destination directory. *
protected void generateAllClassesFile()
* Print all the classes in table format in the file. *
protected void printAllClasses()
* Use the sorted index of all the classes and print all the classes. *
protected void generateContents(java.util.List)
* Given a list of classes, generate links for each class or interface. *
* If the class lind is interface, print it in the italics font. Also all *
* links should target the right-hand frame. If clicked on any class name *
* in this page, appropriate class page should get opened in the right-hand *
* frame. *
protected void printAllClassesTableHeader()
* Print the heading "All Classes" and also print Html table tag. *
protected void printAllClassesTableFooter()
* Print Html closing table tag. *
com.sun.tools.doclets.standard.PackageFrameWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
com.sun.tools.doclets.standard.AbstractPackageWriter
* Class to generate file for each package contents in the left-hand bottom *
* frame. This will list all the Class Kinds in the package. A click on any *
* class-kind will update the right-hand frame with the clicked class-kind page. *
Felder:
Methoden:
public static void generate(com.sun.javadoc.PackageDoc)
* Generate a package summary page for the left-hand bottom frame. Construct *
* the PackageFrameWriter object and then uses it generate the file. *
protected void generateClassListing()
* Generate class listing for all the classes in this package. Divide class *
* listing as per the class kind and generate separate listing for *
* Classes, Interfaces, Exceptions and Errors. *
protected void generateClassKindListing(com.sun.javadoc.ClassDoc[],java.lang.String)
* Generate specific class kind listing. Also add label to the listing. *
protected void printPackageHeader(java.lang.String)
* Print the package link at the top of the class kind listing. Clicking *
* this link, package-summary page will appear in the right hand frame. *
protected void printPackageTableHeader()
* The table for the class kind listing. *
protected void printPackageTableFooter()
* Closing Html tags for table of class kind listing. *
protected void printPackageFooter()
* Do nothing. No footer is generated for this page. *
protected void printPackageDescription()
* Do nothing. Package Description is not generted in this page. *
com.sun.tools.doclets.standard.ClassUseMapper
Hirachie:
java.lang.Object
Felder:
public java.util.Map
* Mapping of ClassDocs to set of PackageDoc used by that class. *
* Entries may be null. *
public java.util.Map
* Mapping of ClassDocs to set of ClassDoc used by that class. *
* Entries may be null. *
public java.util.Map
* Mapping of ClassDocs to list of ClassDoc which are direct or *
* indirect subclasses of that class. *
* Entries may be null. *
public java.util.Map
* Mapping of ClassDocs to list of ClassDoc which are direct or *
* indirect subinterfaces of that interface. *
* Entries may be null. *
public java.util.Map
* Mapping of ClassDocs to list of ClassDoc which implement *
* this interface. *
* Entries may be null. *
public java.util.Map
* Mapping of ClassDocs to list of FieldDoc declared as that class. *
* Entries may be null. *
public java.util.Map
* Mapping of ClassDocs to list of MethodDoc returning that class. *
* Entries may be null. *
public java.util.Map
* Mapping of ClassDocs to list of MethodDoc having that class *
* as an arg. *
* Entries may be null. *
public java.util.Map
* Mapping of ClassDocs to list of MethodDoc which throws that class. *
* Entries may be null. *
public java.util.Map
* Mapping of ClassDocs to list of ConstructorDoc having that class *
* as an arg. *
* Entries may be null. *
public java.util.Map
* Mapping of ClassDocs to list of ConstructorDoc which throws that class. *
* Entries may be null. *
Methoden:
public static void generate(com.sun.javadoc.RootDoc,com.sun.tools.doclets.ClassTree)
* Write out class use pages. *
com.sun.tools.doclets.standard.TreeWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
com.sun.tools.doclets.standard.AbstractTreeWriter
* Generate Class Hierarchy page for all the Classes in this run. Use *
* {@link com.sun.tools.doclets.ClassTree} for building the Tree. The name of *
* the generated file is "overview-tree.html" and it is generated in the *
* current or the destination directory. *
Felder:
Methoden:
public static void generate(com.sun.tools.doclets.standard.ClassTree)
* Create a TreeWriter object and use it to generate the *
* "overview-tree.html" file. *
public void generateTreeFile()
* Print the interface hierarchy and class hierarchy in the file. *
protected void printPackageTreeLinks()
* Generate the links to all the package tree files. *
protected void printTreeHeader()
* Print the navigation bar links at the top. *
protected void printTreeFooter()
* Print the navigation bar links at the bottom. *
protected void printPageHeading()
* Print the page title "Hierarchy For All Packages" at the top of the tree *
* page. *
com.sun.tools.doclets.standard.SplitIndexWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
com.sun.tools.doclets.standard.AbstractIndexWriter
* Generate Separate Index Files for all the member names with Indexing in *
* Unicode Order. This will create "index-files" directory in the current or *
* destination directory and will generate separate file for each unicode index. *
Felder:
protected int
* Previous unicode character index in the built index. *
protected int
* Next unicode character in the built index. *
Methoden:
public static void generate(com.sun.tools.doclets.standard.IndexBuilder)
* Generate separate index files, for each Unicode character, listing all *
* the members starting with the particular unicode character. *
protected void generateIndexFile(java.lang.Character)
* Generate the contents of each index file, with Header, Footer, *
* Member Field, Method and Constructor Description. *
protected void printLinksForIndexes()
* Print Links for all the Index Files per unicode character. *
protected void navLinkPrevious()
* Print the previous unicode character index link. *
protected void navLinkNext()
* Print the next unicode character index link. *
com.sun.tools.doclets.standard.SerialMethodSubWriter
Hirachie:
java.lang.Object
com.sun.tools.doclets.standard.AbstractSubWriter
com.sun.tools.doclets.standard.ExecutableMemberSubWriter
com.sun.tools.doclets.standard.MethodSubWriter
* Generate serialized form for Serializable/Externalizable methods. *
* Documentation denoted by the serialData tag is processed. *
Felder:
Methoden:
public com.sun.javadoc.ProgramElementDoc[] members(com.sun.javadoc.ClassDoc)
protected void printHeader(com.sun.javadoc.ClassDoc)
protected void printMember(com.sun.javadoc.ClassDoc,com.sun.javadoc.ProgramElementDoc)
protected void printSerialDataTag(com.sun.javadoc.Tag[])
protected void printTags(com.sun.javadoc.ProgramElementDoc)
* Print comments, See tags and serialData for SerialMethods. *
public void printMembers(com.sun.javadoc.ClassDoc)
* Print header even if there are no serializable methods. *
com.sun.tools.doclets.standard.HelpWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
* Generate the Help File for the generated API documentation. The help file *
* contents are helpful for browsing the generated documentation. *
Felder:
Methoden:
public static void generate()
* Construct the HelpWriter object and then use it to generate the help *
* file. The name of the generated file is "help-doc.html". The help file *
* will get generated if and only if "-helpfile" and "-nohelp" is not used *
* on the command line. *
protected void generateHelpFile()
* Generate the help file contents. *
protected void printHelpFileContents()
* Print the help file contents from the resource file. While generating the *
* help file contents it also keeps track of user options. If "-notree" *
* is used, then the "overview-tree.html" will not get generated and hence *
* help information also will not get generated. *
protected void navLinkHelp()
* Highlight the word "Help" in the navigation bar as this is the help file. *
com.sun.tools.doclets.standard.PackageTreeWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
com.sun.tools.doclets.standard.AbstractTreeWriter
* Class to generate Tree page for a package. The name of the file generated is *
* "package-tree.html" and it is generated in the respective package directory. *
Felder:
protected com.sun.javadoc.PackageDoc
* Package for which tree is to be generated. *
protected com.sun.javadoc.PackageDoc
* The previous package name in the alpha-order list. *
protected com.sun.javadoc.PackageDoc
* The next package name in the alpha-order list. *
Methoden:
public static void generate(com.sun.javadoc.PackageDoc,com.sun.javadoc.PackageDoc,com.sun.javadoc.PackageDoc,boolean)
* Construct a PackageTreeWriter object and then use it to generate the *
* package tree page. *
protected void generatePackageTreeFile()
* Generate a separate tree file for each package. *
protected void printPackageTreeHeader()
* Print the navigation bar header for the package tree file. *
protected void printLinkToMainTree()
* Generate a link to the tree for all the packages. *
protected void printPackageTreeFooter()
* Print the navigation bar footer for the package tree file. *
protected void navLinkPrevious()
* Link for the previous package tree file. *
protected void navLinkNext()
* Link for the next package tree file. *
protected void navLinkPackage()
* Link to the package summary page for the package of this tree. *
com.sun.tools.doclets.standard.DeprecatedListWriter
Hirachie:
java.lang.Object
java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.HtmlWriter
com.sun.tools.doclets.HtmlDocWriter
com.sun.tools.doclets.standard.HtmlStandardWriter
com.sun.tools.doclets.standard.SubWriterHolderWriter
* Generate File to list all the deprecated classes and class members with the *
* appropriate links. *
Felder:
Methoden:
public static void generate(com.sun.javadoc.RootDoc)
* Get list of all the deprecated classes and members in all the Packages *
* specified on the Command Line. *
* Then instantiate DeprecatedListWriter and generate File. *
protected void generateDeprecatedListFile(com.sun.tools.doclets.standard.DeprecatedAPIListBuilder)
* Print the deprecated API list. Separately print all class kinds and *
* member kinds. *
protected void printDeprecatedHeader()
* Print the navigation bar and header for the deprecated API Listing. *
protected void printDeprecatedFooter()
* Print the navigation bar and the footer for the deprecated API Listing. *
protected void navLinkDeprecated()
* Highlight the word "Deprecated" in the navigation bar as this is the same *
* page. *
com.sun.tools.doclets.standard.Group
Hirachie:
java.lang.Object
* Process and manage grouping of packages, as specified by "-group" option on *
* the command line. *
*
* * For example, if user has used "-group option as * * -group "Core Packages" "java.*" -group "CORBA Packages" "org.omg.*", then * * the packages specified on the command line will be grouped according to their * * names starting with either "java." or "org.omg.". All the other packages * * which do not fall in the user given groups, are grouped in default group, * * named as either "Other Packages" or "Packages" depending upon if "-group" * * option used or not at all used respectively. * *
* ** * Also the packages are grouped according to the longest possible match of * * their names with the grouping information provided. For example, if there * * are two groups, like -group "Lang" "java.lang" and -group "Core" "java.*", * * will put the package java.lang in the group "Lang" and not in group "Core". * *
* Felder: Methoden: public static boolean checkPackageGroups(java.lang.String,java.lang.String,com.sun.javadoc.DocErrorReporter) * Depending upon the format of the package name provided in the "-group" * * option, generate two separate maps. There will be a map for mapping * * regular expression(only meta character allowed is '*' and that is at the * * end of the regular expression) on to the group name. And another map * * for mapping (possible) package names(if the name format doesen't contain * * meta character '*', then it is assumed to be a package name) on to the * * group name. This will also sort all the regular expressions found in the * * reverse order of their lengths, i.e. longest regular expression will be * * first in the sorted list. * public static java.util.Map groupPackages(com.sun.javadoc.PackageDoc[]) * Group the packages according the grouping information provided on the * * command line. Given a list of packages, search each package name in * * regular expression map as well as package name map to get the * * corresponding group name. Create another map with mapping of group name * * to the package list, which will fall under the specified group. If any * * package doesen't belong to any specified group on the comamnd line, then * * a new group named "Other Packages" will be created for it. If there are * * no groups found, in other words if "-group" option is not at all used, * * then all the packages will be grouped under group "Packages". * public static java.util.List getGroupList() * Return the list of groups, in the same order as specified on the command * * line. * com.sun.tools.doclets.standard.PackageUseWriter Hirachie: java.lang.Object java.io.Writer java.io.PrintWriter com.sun.tools.doclets.HtmlWriter com.sun.tools.doclets.HtmlDocWriter com.sun.tools.doclets.standard.HtmlStandardWriter com.sun.tools.doclets.standard.SubWriterHolderWriter * Generate package usage information. * Felder: Methoden: public static void generate(com.sun.tools.doclets.standard.ClassUseMapper,com.sun.javadoc.PackageDoc) * Generate a class page. * protected void generatePackageUseFile() * Print the class use list. * protected void generatePackageUse() * Print the class use list. * protected void generatePackageList() protected void generateClassList() protected void printClassRow(com.sun.javadoc.ClassDoc,com.sun.javadoc.PackageDoc) protected void generatePackageUse(com.sun.javadoc.PackageDoc) * Print the package use list. * protected void printPackageUseHeader() * Print the header for the class use Listing. * protected void printPackageUseFooter() * Print the footer for the class use Listing. * protected void navLinkPackage() * Print this package link * protected void navLinkClassUse() * Print class use link * protected void navLinkTree() com.sun.tools.doclets.standard.ClassWriter Hirachie: java.lang.Object java.io.Writer java.io.PrintWriter com.sun.tools.doclets.HtmlWriter com.sun.tools.doclets.HtmlDocWriter com.sun.tools.doclets.standard.HtmlStandardWriter com.sun.tools.doclets.standard.SubWriterHolderWriter * Generate the Class Information Page. * Felder: protected com.sun.javadoc.ClassDoc protected com.sun.tools.doclets.standard.ClassTree protected com.sun.javadoc.ClassDoc protected com.sun.javadoc.ClassDoc protected boolean protected com.sun.tools.doclets.standard.MethodSubWriter protected com.sun.tools.doclets.standard.ConstructorSubWriter protected com.sun.tools.doclets.standard.FieldSubWriter protected com.sun.tools.doclets.standard.ClassSubWriter Methoden: public static void generate(com.sun.javadoc.ClassDoc,com.sun.javadoc.ClassDoc,com.sun.javadoc.ClassDoc,com.sun.tools.doclets.standard.ClassTree,boolean) * Generate a class page. * protected void navLinkPackage() * Print this package link * protected void navLinkClass() * Print class page indicator * protected void navLinkClassUse() * Print class use link * protected void navLinkPrevious() * Print previous package link * protected void navLinkNext() * Print next package link * public void generateClassFile() * Generate the class file contents. * protected void printAllMembers() * Print summary and detail information for the specified members in the * * class. * protected void printClassDescription() * Print the class description regarding iterfaces implemented, classes * * inheritted. * protected void printDeprecated() * Mark the class as deprecated if it is. * protected void printStep(int) * Generate the step like diagram for the class hierarchy. * protected int printTreeForClass(com.sun.javadoc.ClassDoc) * Print the class hierarchy tree for this class only. * protected void printSubClassInterfaceInfo() * Which are the sub-classes or sub-interfaces for this class? * protected void printImplementingClasses() * If this is the interface which are the classes, that implement this? * protected void printSuperImplementedInterfacesInfo() protected void printInfoHeader() protected void printSubClassLinkInfo(java.util.List) * Generate a link for the sub-classes. * protected void navLinkTree() protected void printSummaryDetailLinks() protected void navSummaryLinks() protected void navDetailLinks() protected void navGap() protected void printEnclosingClassInfo() protected com.sun.javadoc.ClassDoc[] getAllExtendedImplementedInterfaces(com.sun.javadoc.ClassDoc) com.sun.tools.doclets.standard.FieldSubWriter Hirachie: java.lang.Object com.sun.tools.doclets.standard.AbstractSubWriter Felder: Methoden: public com.sun.javadoc.ProgramElementDoc[] members(com.sun.javadoc.ClassDoc) public void printSummaryLabel(com.sun.javadoc.ClassDoc) public void printSummaryAnchor(com.sun.javadoc.ClassDoc) public void printInheritedSummaryAnchor(com.sun.javadoc.ClassDoc) public void printInheritedSummaryLabel(com.sun.javadoc.ClassDoc) protected void printSummaryLink(com.sun.javadoc.ClassDoc,com.sun.javadoc.ProgramElementDoc) protected void printInheritedSummaryLink(com.sun.javadoc.ClassDoc,com.sun.javadoc.ProgramElementDoc) protected void printSummaryType(com.sun.javadoc.ProgramElementDoc) protected void printHeader(com.sun.javadoc.ClassDoc) protected void printBodyHtmlEnd(com.sun.javadoc.ClassDoc) protected void printMember(com.sun.javadoc.ProgramElementDoc) protected void printDeprecatedLink(com.sun.javadoc.ProgramElementDoc) protected void printNavSummaryLink(com.sun.javadoc.ClassDoc,boolean) protected void printNavDetailLink(boolean)