public static void writeModules(String filename) {
Data data = makeHDF();
int i = 0;
for (PackageInfo pkg : chooseModulePackages()) {
data.setValue("reference", "1");
data.setValue("reference.apilevels", sinceTagger.hasVersions() ? "1" : "0");
data.setValue("docs.packages." + i + ".name", pkg.name());
makeModuleListHDF(data, "docs.packages." + i + ".modules", pkg.modules());
for (int j = 0; j < pkg.modules().length; j++) {
Data classData = makeHDF();
ClassInfo mod = pkg.modules()[j];
writeModule(mod, classData);
}
i++;
}
setPageTitle(data, "Module Index");
TagInfo.makeHDF(data, "root.descr", Converter.convertTags(root.inlineTags(), null));
ClearPage.write(data, "modules.cs", filename);
Proofread.writePackages(filename, Converter.convertTags(root.inlineTags(), null));
}
public void makeLink(Data data, String base) {
if (checkLevel()) {
data.setValue(base + ".link", htmlPage());
}
data.setValue(base + ".name", name());
data.setValue(base + ".since.key", SinceTagger.keyForName(getSince()));
data.setValue(base + ".since.name", getSince());
}
public void makeClassLinkListHDF(Data data, String base) {
makeLink(data, base);
ClassInfo.makeLinkListHDF(data, base + ".annotations", getAnnotations());
ClassInfo.makeLinkListHDF(data, base + ".interfaces", getInterfaces());
ClassInfo.makeLinkListHDF(data, base + ".classes", ordinaryClasses());
ClassInfo.makeLinkListHDF(data, base + ".enums", enums());
ClassInfo.makeLinkListHDF(data, base + ".exceptions", exceptions());
ClassInfo.makeLinkListHDF(data, base + ".errors", errors());
data.setValue(base + ".since.key", SinceTagger.keyForName(getSince()));
data.setValue(base + ".since.name", getSince());
}
public static void writePackage(PackageInfo pkg) {
// these this and the description are in the same directory,
// so it's okay
Data data = makePackageHDF();
String name = pkg.name();
data.setValue("package.name", name);
data.setValue("package.since.key", SinceTagger.keyForName(pkg.getSince()));
data.setValue("package.since.name", pkg.getSince());
data.setValue("package.descr", "...description...");
pkg.setFederatedReferences(data, "package");
makeClassListHDF(data, "package.annotations", ClassInfo.sortByName(pkg.getAnnotations()));
makeClassListHDF(data, "package.interfaces", ClassInfo.sortByName(pkg.getInterfaces()));
makeClassListHDF(data, "package.classes", ClassInfo.sortByName(pkg.ordinaryClasses()));
makeClassListHDF(data, "package.modules", ClassInfo.sortByName(pkg.modules()));
makeClassListHDF(data, "package.enums", ClassInfo.sortByName(pkg.enums()));
makeClassListHDF(data, "package.exceptions", ClassInfo.sortByName(pkg.exceptions()));
makeClassListHDF(data, "package.errors", ClassInfo.sortByName(pkg.errors()));
TagInfo[] shortDescrTags = pkg.firstSentenceTags();
TagInfo[] longDescrTags = pkg.inlineTags();
TagInfo.makeHDF(data, "package.shortDescr", shortDescrTags);
TagInfo.makeHDF(data, "package.descr", longDescrTags);
data.setValue(
"package.hasLongDescr", TagInfo.tagsEqual(shortDescrTags, longDescrTags) ? "0" : "1");
String filename = Doclava.javadocDir + pkg.relativePath();
setPageTitle(data, name);
ClearPage.write(data, "package.cs", filename);
filename = javadocDir + pkg.fullDescriptionFile();
setPageTitle(data, name + " Details");
ClearPage.write(data, "package-descr.cs", filename);
Proofread.writePackage(filename, pkg.inlineTags());
}
public static Data makePackageHDF() {
Data data = makeHDF();
ClassInfo[] classes = Converter.rootClasses();
SortedMap<String, PackageInfo> sorted = new TreeMap<String, PackageInfo>();
for (ClassInfo cl : classes) {
PackageInfo pkg = cl.containingPackage();
String name;
if (pkg == null) {
name = "";
} else {
name = pkg.name();
}
sorted.put(name, pkg);
}
int i = 0;
for (String s : sorted.keySet()) {
PackageInfo pkg = sorted.get(s);
if (pkg.isHidden()) {
continue;
}
Boolean allHidden = true;
int pass = 0;
ClassInfo[] classesToCheck = null;
while (pass < 5) {
switch (pass) {
case 0:
classesToCheck = pkg.ordinaryClasses();
break;
case 1:
classesToCheck = pkg.enums();
break;
case 2:
classesToCheck = pkg.errors();
break;
case 3:
classesToCheck = pkg.exceptions();
break;
case 4:
classesToCheck = pkg.getInterfaces();
break;
default:
System.err.println("Error reading package: " + pkg.name());
break;
}
for (ClassInfo cl : classesToCheck) {
if (!cl.isHidden()) {
allHidden = false;
break;
}
}
if (!allHidden) {
break;
}
pass++;
}
if (allHidden) {
continue;
}
data.setValue("reference", "1");
data.setValue("reference.apilevels", sinceTagger.hasVersions() ? "1" : "0");
data.setValue("docs.packages." + i + ".name", s);
data.setValue("docs.packages." + i + ".link", pkg.htmlPage());
data.setValue("docs.packages." + i + ".since.key", SinceTagger.keyForName(pkg.getSince()));
data.setValue("docs.packages." + i + ".since.name", pkg.getSince());
TagInfo.makeHDF(data, "docs.packages." + i + ".shortDescr", pkg.firstSentenceTags());
i++;
}
sinceTagger.writeVersionNames(data);
return data;
}
public static boolean start(RootDoc r) {
String keepListFile = null;
String proofreadFile = null;
String todoFile = null;
String stubsDir = null;
// Create the dependency graph for the stubs directory
String apiFile = null;
HashSet<String> stubPackages = null;
ArrayList<String> knownTagsFiles = new ArrayList<String>();
root = r;
String[][] options = r.options();
for (String[] a : options) {
if (a[0].equals("-d")) {
ClearPage.outputDir = a[1];
} else if (a[0].equals("-templatedir")) {
ClearPage.addTemplateDir(a[1]);
} else if (a[0].equals("-hdf")) {
mHDFData.add(new String[] {a[1], a[2]});
} else if (a[0].equals("-markdown")) {
mMarkdown.add(new String[] {a[1], a[2], a[3]});
} else if (a[0].equals("-knowntags")) {
knownTagsFiles.add(a[1]);
} else if (a[0].equals("-toroot")) {
ClearPage.toroot = a[1];
} else if (a[0].equals("-title")) {
Doclava.title = a[1];
} else if (a[0].equals("-werror")) {
Errors.setWarningsAreErrors(true);
} else if (a[0].equals("-error") || a[0].equals("-warning") || a[0].equals("-hide")) {
try {
int level = -1;
if (a[0].equals("-error")) {
level = Errors.ERROR;
} else if (a[0].equals("-warning")) {
level = Errors.WARNING;
} else if (a[0].equals("-hide")) {
level = Errors.HIDDEN;
}
Errors.setErrorLevel(Integer.parseInt(a[1]), level);
} catch (NumberFormatException e) {
// already printed below
return false;
}
} else if (a[0].equals("-keeplist")) {
keepListFile = a[1];
} else if (a[0].equals("-proofread")) {
proofreadFile = a[1];
} else if (a[0].equals("-todo")) {
todoFile = a[1];
} else if (a[0].equals("-public")) {
showLevel = SHOW_PUBLIC;
} else if (a[0].equals("-protected")) {
showLevel = SHOW_PROTECTED;
} else if (a[0].equals("-package")) {
showLevel = SHOW_PACKAGE;
} else if (a[0].equals("-private")) {
showLevel = SHOW_PRIVATE;
} else if (a[0].equals("-hidden")) {
showLevel = SHOW_HIDDEN;
} else if (a[0].equals("-stubs")) {
stubsDir = a[1];
} else if (a[0].equals("-stubpackages")) {
stubPackages = new HashSet<String>();
for (String pkg : a[1].split(":")) {
stubPackages.add(pkg);
}
} else if (a[0].equals("-apixml")) {
apiFile = a[1];
} else if (a[0].equals("-nodocs")) {
generateDocs = false;
} else if (a[0].equals("-parsecomments")) {
parseComments = true;
} else if (a[0].equals("-since")) {
sinceTagger.addVersion(a[1], a[2]);
} else if (a[0].equals("-federate")) {
try {
String name = a[1];
URL federationURL = new URL(a[2]);
federationTagger.addSiteUrl(name, federationURL);
} catch (MalformedURLException e) {
System.err.println("Could not parse URL for federation: " + a[1]);
return false;
}
} else if (a[0].equals("-federationxml")) {
String name = a[1];
String file = a[2];
federationTagger.addSiteXml(name, file);
} else if (a[0].equals("-apiversion")) {
apiVersion = a[1];
} else if (a[0].equals("-assetsdir")) {
assetsOutputDir = a[1];
} else if (a[0].equals("-generatesources")) {
generateSources = true;
}
}
if (!readKnownTagsFiles(knownTags, knownTagsFiles)) {
return false;
}
// Set up the data structures
Converter.makeInfo(r);
// Stubs and xml
final File currentApiFile;
if (!generateDocs && apiFile != null) {
currentApiFile = new File(apiFile);
} else if (generateDocs) {
currentApiFile =
new File(ensureSlash(ClearPage.outputDir) + javadocDir + FederatedSite.XML_API_PATH);
} else {
currentApiFile = null;
}
Stubs.writeStubsAndXml(stubsDir, currentApiFile, stubPackages);
if (generateDocs && apiFile != null) {
ClearPage.copyFile(currentApiFile, new File(apiFile));
}
// Reference documentation
if (generateDocs) {
ClearPage.addBundledTemplateDir("assets/customizations");
ClearPage.addBundledTemplateDir("assets/templates");
List<ResourceLoader> resourceLoaders = new ArrayList<ResourceLoader>();
List<String> templates = ClearPage.getTemplateDirs();
for (String tmpl : templates) {
resourceLoaders.add(new FileSystemResourceLoader(tmpl));
}
templates = ClearPage.getBundledTemplateDirs();
for (String tmpl : templates) {
resourceLoaders.add(new ClassResourceLoader(Doclava.class, '/' + tmpl));
}
ResourceLoader compositeResourceLoader = new CompositeResourceLoader(resourceLoaders);
jSilver = new JSilver(compositeResourceLoader);
if (!Doclava.readTemplateSettings()) {
return false;
}
long startTime = System.nanoTime();
// Use current version information
if (apiVersion != null && sinceTagger.hasVersions()) {
sinceTagger.addVersion(currentApiFile.getAbsolutePath(), apiVersion);
}
// Apply @since tags from the XML file
sinceTagger.tagAll(Converter.rootClasses());
// Apply details of federated documentation
federationTagger.tagAll(Converter.rootClasses());
// Files for proofreading
if (proofreadFile != null) {
Proofread.initProofread(proofreadFile);
}
if (todoFile != null) {
TodoFile.writeTodoFile(todoFile);
}
writeAssets();
// Navigation tree
NavTree.writeNavTree(assetsOutputDir);
// Write Markdown files
writeMarkdowns();
// Mule
writeModules(muleXmlDir + "modules" + htmlExtension);
// Packages Pages
writePackages(javadocDir + "packages" + htmlExtension);
// Classes
writeClassLists();
writeClasses();
writeHierarchy();
// writeKeywords();
// Lists for JavaScript
writeLists();
if (keepListFile != null) {
writeKeepList(keepListFile);
}
// Index page
writeIndex();
// Installation page
writeInstall();
Proofread.finishProofread(proofreadFile);
long time = System.nanoTime() - startTime;
System.out.println(
"Mule DevKit took "
+ (time / 1000000000)
+ " sec. to write docs to "
+ ClearPage.outputDir);
}
Errors.printErrors();
return !Errors.hadError;
}
