| Methods Summary |
|---|
| protected java.lang.String | classFileName(com.sun.javadoc.ClassDoc cd)
return cd.qualifiedName() + ".html";
|
| public static ConfigurationStandard | configuration()Return the configuration instance. Create if it doesn't exist.
Override this method to use a different
configuration.
if (HtmlDocWriter.configuration == null) {
HtmlDocWriter.configuration = new ConfigurationStandard();
}
return (ConfigurationStandard)HtmlDocWriter.configuration;
|
| protected void | generateClassCycle(com.sun.javadoc.ClassDoc[] arr, ClassTree classtree, boolean nopackage)Instantiate ClassWriter for each Class within the ClassDoc[]
passed to it and generate Documentation for that.
Arrays.sort(arr);
for(int i = 0; i < arr.length; i++) {
if (configuration().nodeprecated &&
arr[i].tags("deprecated").length > 0) {
continue;
}
ClassDoc prev = (i == 0)?
null:
arr[i-1];
ClassDoc curr = arr[i];
ClassDoc next = (i+1 == arr.length)?
null:
arr[i+1];
ClassWriter.generate(curr, prev, next, classtree, nopackage);
}
|
| protected void | generateClassFiles(com.sun.javadoc.RootDoc root, ClassTree classtree)
ClassDoc[] classes = root.specifiedClasses();
List incl = new ArrayList();
for (int i = 0; i < classes.length; i++) {
ClassDoc cd = classes[i];
if (cd.isIncluded() && isGeneratedDoc(cd)) {
incl.add(cd);
}
}
ClassDoc[] inclClasses = new ClassDoc[incl.size()];
for (int i = 0; i < inclClasses.length; i++) {
inclClasses[i] = (ClassDoc)incl.get(i);
}
generateClassCycle(inclClasses, classtree, true);
PackageDoc[] packages = configuration().packages;
for (int i = 0; i < packages.length; i++) {
PackageDoc pkg = packages[i];
generateClassCycle(pkg.interfaces(), classtree, false);
generateClassCycle(pkg.ordinaryClasses(), classtree, false);
generateClassCycle(pkg.exceptions(), classtree, false);
generateClassCycle(pkg.errors(), classtree, false);
}
|
| public static boolean | isGeneratedDoc(com.sun.javadoc.Doc 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.
if (!configuration().nodeprecated) {
return true;
}
return (doc.tags("deprecated")).length == 0;
|
| public static int | optionLength(java.lang.String option)Check for doclet added options here.
return configuration().optionLength(option);
|
| protected void | performCopy(java.lang.String configdestdir, java.lang.String filename)
try {
String destdir = (configdestdir.length() > 0)?
destdir = configdestdir + File.separatorChar: "";
if (filename.length() > 0) {
File helpstylefile = new File(filename);
String parent = helpstylefile.getParent();
String helpstylefilename = (parent == null)?
filename:
filename.substring(parent.length() + 1);
File desthelpfile = new File(destdir + helpstylefilename);
if (!desthelpfile.getCanonicalPath().equals(
helpstylefile.getCanonicalPath())) {
configuration().standardmessage.
notice("doclet.Copying_File_0_To_File_1",
helpstylefile.toString(), desthelpfile.toString());
Util.copyFile(desthelpfile, helpstylefile);
}
}
} catch (IOException exc) {
configuration().standardmessage.
error("doclet.perform_copy_exception_encountered",
exc.toString());
throw new DocletAbortException();
}
|
| public static boolean | start(com.sun.javadoc.RootDoc root)The "start" method as required by Javadoc.
try {
configuration().setOptions(root);
(new Standard()).startGeneration(root);
} catch (DocletAbortException exc) {
//exc.printStackTrace();
return false; // message has already been displayed
}
return true;
|
| protected void | startGeneration(com.sun.javadoc.RootDoc root)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.
if (root.classes().length == 0) {
configuration().standardmessage.
error("doclet.No_Public_Classes_To_Document");
return;
}
if (configuration().topFile.length() == 0) {
configuration().standardmessage.
error("doclet.No_Non_Deprecated_Classes_To_Document");
return;
}
boolean nodeprecated = configuration().nodeprecated;
String configdestdir = configuration().destdirname;
String confighelpfile = configuration().helpfile;
String configstylefile = configuration().stylesheetfile;
performCopy(configdestdir, confighelpfile);
performCopy(configdestdir, configstylefile);
ClassTree classtree = new ClassTree(root, nodeprecated);
// do early to reduce memory footprint
if (configuration().classuse) {
ClassUseMapper.generate(root, classtree);
}
IndexBuilder indexbuilder = new IndexBuilder(root, nodeprecated);
PackageDoc[] packages = configuration().packages;
if (configuration().createtree) {
TreeWriter.generate(classtree);
}
if (configuration().createindex) {
if (configuration().splitindex) {
SplitIndexWriter.generate(indexbuilder);
} else {
SingleIndexWriter.generate(indexbuilder);
}
}
if (!(configuration().nodeprecatedlist || nodeprecated)) {
DeprecatedListWriter.generate(root);
}
AllClassesFrameWriter.generate(new IndexBuilder(root, nodeprecated,
true));
FrameOutputWriter.generate();
PackagesFileWriter.generate();
if (configuration().createoverview) {
PackageIndexWriter.generate(root);
}
if (packages.length > 1) {
PackageIndexFrameWriter.generate();
}
for(int i = 0; i < packages.length; i++) {
PackageDoc prev = (i == 0)?
null:
packages[i-1];
PackageDoc packagedoc = packages[i];
PackageDoc next = (i+1 == packages.length)?
null:
packages[i+1];
PackageWriter.generate(packages[i], prev, next);
if (configuration().createtree) {
PackageTreeWriter.generate(packages[i], prev, next,
nodeprecated);
}
PackageFrameWriter.generate(packages[i]);
}
generateClassFiles(root, classtree);
SerializedFormWriter.generate(root);
PackageListWriter.generate(root);
if (configuration().helpfile.length() == 0 &&
!configuration().nohelp) {
HelpWriter.generate();
}
if (configuration().stylesheetfile.length() == 0) {
StylesheetWriter.generate();
}
|
| public static boolean | validOptions(java.lang.String[][] options, com.sun.javadoc.DocErrorReporter reporter)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.
return configuration().validOptions(options, reporter);
|
