code cleanup : annotations for S.M. modification removed

This commit is contained in:
stfm
2012-06-23 01:19:41 +02:00
parent 8b21423bc7
commit bafe49c1c5
5 changed files with 28 additions and 298 deletions

View File

@@ -67,7 +67,6 @@ public class ClassHierachy extends java.lang.Object {
TeXDoclet.os.print("\\hspace{" + Double.toString(indent) TeXDoclet.os.print("\\hspace{" + Double.toString(indent)
+ "cm} $\\bullet$ " + "cm} $\\bullet$ "
+ HTMLtoLaTeXBackEnd.fixText(qualifName) + " {\\tiny "); + HTMLtoLaTeXBackEnd.fixText(qualifName) + " {\\tiny ");
// (S.M. modification) only for resolved classes
if (cls != null) { if (cls != null) {
TeXDoclet.printRef(cls.containingPackage(), cls.name(), ""); TeXDoclet.printRef(cls.containingPackage(), cls.name(), "");
} }

View File

@@ -47,7 +47,6 @@ public class HTMLtoLaTeXBackEnd extends HTMLEditorKit.ParserCallback {
Hashtable colors = new Hashtable(10); Hashtable colors = new Hashtable(10);
String block = ""; String block = "";
String refurl = null; String refurl = null;
// S.M. modification : doNotPrintURL changed to doPrintURL
String doPrintURL = null; String doPrintURL = null;
String refname = null; String refname = null;
String refimg = null; String refimg = null;
@@ -98,7 +97,6 @@ public class HTMLtoLaTeXBackEnd extends HTMLEditorKit.ParserCallback {
} else if (tag == HTML.Tag.IMG) { } else if (tag == HTML.Tag.IMG) {
String refimg = (String) attrSet.getAttribute(HTML.Attribute.SRC); String refimg = (String) attrSet.getAttribute(HTML.Attribute.SRC);
// (S.M. modification) include images not in java source as link
if (refimg.indexOf("://") != -1) { if (refimg.indexOf("://") != -1) {
// if (refimg.indexOf("http://") == 0) { // if (refimg.indexOf("http://") == 0) {
@@ -249,7 +247,6 @@ public class HTMLtoLaTeXBackEnd extends HTMLEditorKit.ParserCallback {
ret.append("{\\bf "); ret.append("{\\bf ");
} else if (tag == HTML.Tag.A) { } else if (tag == HTML.Tag.A) {
refurl = (String) attrSet.getAttribute(HTML.Attribute.HREF); refurl = (String) attrSet.getAttribute(HTML.Attribute.HREF);
// (S.M. modification)
doPrintURL = (String) attrSet.getAttribute("doprinturl"); doPrintURL = (String) attrSet.getAttribute("doprinturl");
if (refurl != null) { if (refurl != null) {
if (TeXDoclet.hyperref) { if (TeXDoclet.hyperref) {
@@ -396,8 +393,6 @@ public class HTMLtoLaTeXBackEnd extends HTMLEditorKit.ParserCallback {
} else if (tag == HTML.Tag.A) { } else if (tag == HTML.Tag.A) {
if (refurl != null) { if (refurl != null) {
ret.append("}"); ret.append("}");
// S.M. modification : doPrintURL must be set instead of
// doNotPrintUrl
if (doPrintURL != null) { if (doPrintURL != null) {
if (!refurl.equals("")) { if (!refurl.equals("")) {
ret.append("(at "); ret.append("(at ");

View File

@@ -6,7 +6,6 @@ public class HelpOutput {
System.err.println("TeXDoclet Usage:"); System.err.println("TeXDoclet Usage:");
System.err System.err
.println("-title <title> A title to use for the generated output document."); .println("-title <title> A title to use for the generated output document.");
// (S.M. modification)
System.err System.err
.println("-subtitle <title> A subtitle for the output document."); .println("-subtitle <title> A subtitle for the output document.");
System.err System.err
@@ -43,21 +42,15 @@ public class HelpOutput {
.println("-serial Do print Serializable information."); .println("-serial Do print Serializable information.");
System.err System.err
.println("-nosummaries Do print summaries of fiels, constructors and methods."); .println("-nosummaries Do print summaries of fiels, constructors and methods.");
// (S.M. modification)
System.err System.err
.println("-nofieldsummary Do not print field summaries"); .println("-nofieldsummary Do not print field summaries");
// (S.M. modification)
System.err System.err
.println("-noconstructorsummary Do not print constructor summaries"); .println("-noconstructorsummary Do not print constructor summaries");
System.err System.err
.println("-noinherited Do not include inherited API information in output."); .println("-noinherited Do not include inherited API information in output.");
// (S.M. modification)
System.err System.err
.println("-shortinherited Prints a short inheritance, only the member name (not the whole signature)"); .println("-shortinherited Prints a short inheritance, only the member name (not the whole signature)");
System.err.println("-noindex Do not create index."); System.err.println("-noindex Do not create index.");
// (S.M. modification) System.err.println(
// "-notree Do not create a class tree." );
// no class tree is default
System.err.println("-tree Create a class tree."); System.err.println("-tree Create a class tree.");
System.err System.err
.println("-treeindent <float> Indent <float>cm i the class tree. Default is 1cm."); .println("-treeindent <float> Indent <float>cm i the class tree. Default is 1cm.");
@@ -66,8 +59,6 @@ public class HelpOutput {
System.err System.err
.println("-pdfhyperref Use the hyperref package with pdf. Overrides -hypertex."); .println("-pdfhyperref Use the hyperref package with pdf. Overrides -hypertex.");
System.err.println("-version Includes version-tags."); System.err.println("-version Includes version-tags.");
// ----- (S.M. modification)
System.err System.err
.println("-hr Prints horizontal rows in the output (to get a better? view)."); .println("-hr Prints horizontal rows in the output (to get a better? view).");
System.err System.err
@@ -77,8 +68,6 @@ public class HelpOutput {
System.err System.err
.println("-imagespath Path to the texdoclet_images dir (absolute or relative to the output document .tex file)."); .println("-imagespath Path to the texdoclet_images dir (absolute or relative to the output document .tex file).");
// ----- (S.M. modification end)
} }
} }

View File

@@ -67,7 +67,6 @@ public class InterfaceHierachy extends java.lang.Object {
TeXDoclet.os.print("\\hspace{" + Double.toString(indent) TeXDoclet.os.print("\\hspace{" + Double.toString(indent)
+ "cm} $\\bullet$ " + "cm} $\\bullet$ "
+ HTMLtoLaTeXBackEnd.fixText(qualifName) + " {\\tiny "); + HTMLtoLaTeXBackEnd.fixText(qualifName) + " {\\tiny ");
// (S.M. modification) only for resolved classes
if (cls != null) { if (cls != null) {
TeXDoclet.printRef(cls.containingPackage(), cls.name(), ""); TeXDoclet.printRef(cls.containingPackage(), cls.name(), "");
} }

View File

@@ -121,7 +121,6 @@ public class TeXDoclet extends Doclet {
private static final String OUT_FILENAME_DOCS_TEX = "docs.tex"; private static final String OUT_FILENAME_DOCS_TEX = "docs.tex";
private static final String OUT_PREAMBLE_SUFFIX = "_preamble"; private static final String OUT_PREAMBLE_SUFFIX = "_preamble";
// (S.M. modification)
public static final String SECTION_LEVEL = "section"; public static final String SECTION_LEVEL = "section";
public static final String CHAPTER_LEVEL = "chapter"; public static final String CHAPTER_LEVEL = "chapter";
public static final String SUBSECTION_LEVEL = "subsection"; public static final String SUBSECTION_LEVEL = "subsection";
@@ -162,11 +161,10 @@ public class TeXDoclet extends Doclet {
static String packageFile = "docpackage.tex"; static String packageFile = "docpackage.tex";
static String preambleFile = "docinit.tex"; static String preambleFile = "docinit.tex";
static File packageDir = null; static File packageDir = null;
// static Hashtable appendencies = new Hashtable(); static Hashtable appendencies = new Hashtable();
static Hashtable refs = new Hashtable(); static Hashtable refs = new Hashtable();
static Hashtable externalrefs = new Hashtable(); static Hashtable externalrefs = new Hashtable();
// ------ (S.M. modification)
static boolean includeTexOutputInOtherTexFile = false; static boolean includeTexOutputInOtherTexFile = false;
static String sectionLevelMax = null; static String sectionLevelMax = null;
static String[] sectionLevels = new String[3]; static String[] sectionLevels = new String[3];
@@ -183,8 +181,6 @@ public class TeXDoclet extends Doclet {
static String subtitle = null; static String subtitle = null;
static String introFile = null; static String introFile = null;
// ------ (S.M. modification end)
/* /*
* Testing entry point for testing tables * Testing entry point for testing tables
*/ */
@@ -328,9 +324,6 @@ public class TeXDoclet extends Doclet {
index = false; index = false;
} else if (args[i][0].equals("-twosided")) { } else if (args[i][0].equals("-twosided")) {
twosided = true; twosided = true;
// (S.M. modification)
// } else if ( args[i][0].equals( "-notree" ) ) {
// overview = false;
} else if (args[i][0].equals("-tree")) { } else if (args[i][0].equals("-tree")) {
classtree = true; classtree = true;
} else if (args[i][0].equals("-hyperref")) { } else if (args[i][0].equals("-hyperref")) {
@@ -352,8 +345,6 @@ public class TeXDoclet extends Doclet {
} catch (Exception e) { } catch (Exception e) {
e.printStackTrace(); e.printStackTrace();
} }
// ----------- (S.M. modification)
} else if (args[i][0].equals("-nofieldsummary")) { } else if (args[i][0].equals("-nofieldsummary")) {
useFieldSummary = false; useFieldSummary = false;
} else if (args[i][0].equals("-noconstructorsummary")) { } else if (args[i][0].equals("-noconstructorsummary")) {
@@ -385,7 +376,6 @@ public class TeXDoclet extends Doclet {
+ " (use \"subsection\",\"section\" or \"chapter\")"); + " (use \"subsection\",\"section\" or \"chapter\")");
return false; return false;
} }
// ----------- (S.M. modification end)
} }
System.out.println("args parsed"); System.out.println("args parsed");
@@ -401,7 +391,7 @@ public class TeXDoclet extends Doclet {
} catch (Exception ex) { } catch (Exception ex) {
ex.printStackTrace(); ex.printStackTrace();
} }
// (S.M. modification)
try { try {
if (includeTexOutputInOtherTexFile) { if (includeTexOutputInOtherTexFile) {
outfilePreamble = outfile outfilePreamble = outfile
@@ -413,7 +403,6 @@ public class TeXDoclet extends Doclet {
ex.printStackTrace(); ex.printStackTrace();
} }
// (S.M. modification)
initSections(); initSections();
} }
@@ -455,7 +444,6 @@ public class TeXDoclet extends Doclet {
} catch (Exception ex) { } catch (Exception ex) {
} }
} }
// (S.M. modification)
if (osPreamble != null) { if (osPreamble != null) {
try { try {
osPreamble.close(); osPreamble.close();
@@ -485,7 +473,6 @@ public class TeXDoclet extends Doclet {
init(); init();
// (S.M. modification)
if (!includeTexOutputInOtherTexFile) { if (!includeTexOutputInOtherTexFile) {
printPreamble(os); printPreamble(os);
@@ -515,7 +502,6 @@ public class TeXDoclet extends Doclet {
if (root.inlineTags().length > 0) { if (root.inlineTags().length > 0) {
// (S.M. modification)
os.println("\\" + sectionLevels[0] + "*{Introduction}{"); os.println("\\" + sectionLevels[0] + "*{Introduction}{");
os.println(" \\addcontentsline{toc}{" + sectionLevels[0] os.println(" \\addcontentsline{toc}{" + sectionLevels[0]
+ "}{Introduction}"); + "}{Introduction}");
@@ -584,45 +570,29 @@ public class TeXDoclet extends Doclet {
// Packages // Packages
// os.println( "\\gdef\\packagename{}" );
// os.println( "\\gdef\\classname{}" );
Enumeration e = map.elements(); Enumeration e = map.elements();
while (e.hasMoreElements()) { while (e.hasMoreElements()) {
final Package pkg = (Package) e.nextElement(); final Package pkg = (Package) e.nextElement();
// System.out.println("processing Package: " + pkg.pkg);
// (S.M. modification)
// os.println( "\\newpage" ); // os.println( "\\newpage" );
// os.println(
// "\\def\\packagename{"+HTMLtoLaTeXBackEnd.fixText(pkg.pkg)+"}" );
addFile(os, packageFile, false); addFile(os, packageFile, false);
// (S.M. modification)
// os.println(
// "\\section"+BOLD+" Package "+HTMLtoLaTeXBackEnd.fixText(pkg.pkg)
// +"}{" );
os.println("\\" + sectionLevels[0] + "{Package " os.println("\\" + sectionLevels[0] + "{Package "
+ HTMLtoLaTeXBackEnd.fixText(pkg.pkg) + "}{"); + HTMLtoLaTeXBackEnd.fixText(pkg.pkg) + "}{");
// (S.M. modification)
// os.println( "\\thispagestyle{empty}" );
os.print("\\label{" + refName(makeRefKey(pkg.pkg)) + "}"); os.print("\\label{" + refName(makeRefKey(pkg.pkg)) + "}");
if (hyperref) { if (hyperref) {
os.println("\\hypertarget{" + refName(makeRefKey(pkg.pkg)) os.println("\\hypertarget{" + refName(makeRefKey(pkg.pkg))
+ "}{}"); + "}{}");
} }
// (S.M. modification)
// os.println( // os.println(
// "\\markboth{\\protect\\packagename}{\\protect\\packagename}" ); // "\\markboth{\\protect\\packagename}{\\protect\\packagename}" );
// os.println( // os.println(
// "\\markboth{\\protect\\packagename \\hspace{.02in} -- \\protect\\classname}{\\protect\\packagename \\hspace{.02in} -- \\protect\\classname}" // "\\markboth{\\protect\\packagename \\hspace{.02in} -- \\protect\\classname}{\\protect\\packagename \\hspace{.02in} -- \\protect\\classname}"
// ); // );
// (S.M. modification)
if (ITALIC.indexOf("textit") != -1) { if (ITALIC.indexOf("textit") != -1) {
os.println("\\hskip -.05in"); os.println("\\hskip -.05in");
} }
@@ -646,7 +616,6 @@ public class TeXDoclet extends Doclet {
if (pkg.pkgDoc.inlineTags().length > 0) { if (pkg.pkgDoc.inlineTags().length > 0) {
printTags(pkg.pkgDoc.inlineTags()); printTags(pkg.pkgDoc.inlineTags());
// (S.M. modification)
if (useHr) { if (useHr) {
os.println("\\mbox{}\\\\ \\rule{\\hsize}{.7mm}"); os.println("\\mbox{}\\\\ \\rule{\\hsize}{.7mm}");
} }
@@ -655,7 +624,6 @@ public class TeXDoclet extends Doclet {
} }
} }
// (S.M. modification)
// os.println( "\\newpage"); // os.println( "\\newpage");
// os.println( // os.println(
// "\\markboth{\\protect\\packagename \\hspace{.02in} -- \\protect\\classname}{\\protect\\packagename \\hspace{.02in} -- \\protect\\classname}" // "\\markboth{\\protect\\packagename \\hspace{.02in} -- \\protect\\classname}{\\protect\\packagename \\hspace{.02in} -- \\protect\\classname}"
@@ -668,20 +636,24 @@ public class TeXDoclet extends Doclet {
os.println("}"); os.println("}");
} }
/*
* if (appendencies.size() > 0) { os.println("\\appendix"); Iterator it
* = appendencies.keySet().iterator(); while (it.hasNext()) {
* //os.println
* (" \\chapter{"+(char)('A'+1)+"}\n\\hyperdef{appendix1}{}sdafafdasd");
* os.println(" \\hyperdef{appendix1}{}sdafafdasd"); String sfa =
* (String) it.next(); System.out.println(sfa); //addFile(sfa, true); }
* }
*/
/* // if (appendencies.size() > 0) {
* os.println("\\markboth{}{}"); if (index) { os.println( "\\printindex" // os.println("\\appendix");
* ); } // Iterator it = appendencies.keySet().iterator();
*/ // while (it.hasNext()) {
// os.println(" \\chapter{" + (char) ('A' + 1)
// + "}\n\\hyperdef{appendix1}{}");
// os.println(" \\hyperdef{appendix1}{}sdafafdasd");
// String sfa = (String) it.next();
// System.out.println(sfa);
// addFile(os, sfa, true);
// }
// }
// os.println("\\markboth{}{}");
// if (index) {
// os.println("\\printindex");
// }
addFile(os, finishFile, false); addFile(os, finishFile, false);
@@ -699,7 +671,6 @@ public class TeXDoclet extends Doclet {
// this is not our job if including in other document // this is not our job if including in other document
if (!includeTexOutputInOtherTexFile) { if (!includeTexOutputInOtherTexFile) {
// (S.M. modification) koma script support (scrreprt, scrartcl)
if (docclass.equals("scrreprt") || docclass.equals("scrartcl")) { if (docclass.equals("scrreprt") || docclass.equals("scrartcl")) {
os.println("\\documentclass[11pt,a4paper,titlepage,smallheadings," os.println("\\documentclass[11pt,a4paper,titlepage,smallheadings,"
+ "headinclude,headsepline,DIV13,BCOR12.5mm"); + "headinclude,headsepline,DIV13,BCOR12.5mm");
@@ -721,24 +692,13 @@ public class TeXDoclet extends Doclet {
printPreambleNewCommands(os); printPreambleNewCommands(os);
// os.println("\\definecolor{Light}{gray}{.90}");
printPreambleTitle(os); printPreambleTitle(os);
// already set in \\usepackage{fullpage} option
// os.println("\\pagestyle{" + style + "}");
// (S.M. modification) some stuff uncommented
// os.println("\\addtocontents{toc}{\\protect\\thispagestyle{empty}}"); // os.println("\\addtocontents{toc}{\\protect\\thispagestyle{empty}}");
// os.println("\\addtocontents{toc}{\\protect\\def\\protect\\packagename{}}"); // os.println("\\addtocontents{toc}{\\protect\\def\\protect\\packagename{}}");
// os.println("\\addtocontents{toc}{\\protect\\def\\protect\\classname{}}"); // os.println("\\addtocontents{toc}{\\protect\\def\\protect\\classname{}}");
// os.println("\\oddsidemargin 0in");
// os.println("\\evensidemargin 0in");
// os.println("\\topmargin -.3in");
os.println("\\chardef\\textbackslash=`\\\\"); os.println("\\chardef\\textbackslash=`\\\\");
// os.println("\\textheight 9.4in");
// os.println("\\textwidth 6.5in");
if (index) { if (index) {
os.println("\\makeindex"); os.println("\\makeindex");
@@ -750,15 +710,10 @@ public class TeXDoclet extends Doclet {
static void printPreambleUsePackages(PrintWriter os) { static void printPreambleUsePackages(PrintWriter os) {
os.println("\\usepackage{color}"); os.println("\\usepackage{color}");
// (S.M. modification)
// os.println("\\usepackage{graphicx}");
// os.println("\\usepackage{amsfonts}");
// os.println("\\usepackage{amsmath}");
os.println("\\usepackage{ifthen}"); os.println("\\usepackage{ifthen}");
if (index) { if (index) {
os.println("\\usepackage{makeidx}"); os.println("\\usepackage{makeidx}");
} }
// (S.M. modification)
os.println("\\usepackage{ifpdf}"); os.println("\\usepackage{ifpdf}");
os.println("\\usepackage[" + style + "]{fullpage}"); os.println("\\usepackage[" + style + "]{fullpage}");
} }
@@ -809,9 +764,6 @@ public class TeXDoclet extends Doclet {
os.println(" \\makebox[\\hsize]{%"); os.println(" \\makebox[\\hsize]{%");
os.println(" \\parbox{.4in}{}%"); os.println(" \\parbox{.4in}{}%");
os.println(" \\parbox[l]{5in}{%"); os.println(" \\parbox[l]{5in}{%");
// (S.M. modification) no italic for first sentence of class
// description
// os.println(" \\vspace{1mm}\\it%");
os.println(" \\vspace{1mm}%"); os.println(" \\vspace{1mm}%");
os.println(" #3%"); os.println(" #3%");
os.println(" \\vspace{1mm}%"); os.println(" \\vspace{1mm}%");
@@ -819,21 +771,6 @@ public class TeXDoclet extends Doclet {
os.println(" }%"); os.println(" }%");
os.println("}"); os.println("}");
// (S.M. modification)
// os.println("\\newcommand{\\isep}[0]{%");
// os.println("\\setlength{\\itemsep}{-.4ex}");
// os.println("}");
//
// os.println("\\newcommand{\\sld}[0]{%");
// os.println("\\setlength{\\topsep}{0em}");
// os.println("\\setlength{\\partopsep}{0em}");
// os.println("\\setlength{\\parskip}{0em}");
// os.println("\\setlength{\\parsep}{-1em}");
// os.println("}");
// os.println("\\newcommand{\\membername}[1]{{\\it #1}\\linebreak}");
if (useHr) { if (useHr) {
os.println("\\newcommand{\\divideents}[1]{\\vskip -1em\\indent\\rule{2in}{.5mm}}"); os.println("\\newcommand{\\divideents}[1]{\\vskip -1em\\indent\\rule{2in}{.5mm}}");
} }
@@ -841,9 +778,6 @@ public class TeXDoclet extends Doclet {
os.println("\\newcommand{\\refdefined}[1]{"); os.println("\\newcommand{\\refdefined}[1]{");
os.println("\\expandafter\\ifx\\csname r@#1\\endcsname\\relax"); os.println("\\expandafter\\ifx\\csname r@#1\\endcsname\\relax");
os.println("\\relax\\else"); os.println("\\relax\\else");
// (S.M. modification)
// os.println("{$($in \\ref{#1}, page \\pageref{#1}$)$}");
// os.println("\\fi}" );
os.println("{$($in \\ref{#1}, page \\pageref{#1}$)$}\\fi}"); os.println("{$($in \\ref{#1}, page \\pageref{#1}$)$}\\fi}");
} }
@@ -896,9 +830,6 @@ public class TeXDoclet extends Doclet {
if (v.size() > 0) { if (v.size() > 0) {
os.println("\\vskip .13in"); os.println("\\vskip .13in");
// os.println("\\hbox" + BOLD + " "
// + HTMLtoLaTeXBackEnd.fixText(title) + "}");
os.println("\\hbox{" + BOLD + " " os.println("\\hbox{" + BOLD + " "
+ HTMLtoLaTeXBackEnd.fixText(title) + "}}"); + HTMLtoLaTeXBackEnd.fixText(title) + "}}");
@@ -922,7 +853,6 @@ public class TeXDoclet extends Doclet {
static void printClassHierarchy(RootDoc root) { static void printClassHierarchy(RootDoc root) {
// (S.M. modification)
os.println("\\" + sectionLevels[0] + "*{Class Hierarchy}{"); os.println("\\" + sectionLevels[0] + "*{Class Hierarchy}{");
os.println("\\thispagestyle{empty}"); os.println("\\thispagestyle{empty}");
@@ -942,10 +872,8 @@ public class TeXDoclet extends Doclet {
} }
if (classHierachy.root.size() != 0) { if (classHierachy.root.size() != 0) {
// (S.M. modification)
os.println("\\" + sectionLevels[1] + "*{Classes}"); os.println("\\" + sectionLevels[1] + "*{Classes}");
// (S.M. modification) raggedright needed here for correct indent
os.println("{\\raggedright"); os.println("{\\raggedright");
classHierachy.printTree(root, overviewindent); classHierachy.printTree(root, overviewindent);
@@ -963,10 +891,7 @@ public class TeXDoclet extends Doclet {
} }
} }
if (interfaceHierachy.root.size() != 0) { if (interfaceHierachy.root.size() != 0) {
// (S.M. modification)
// os.println( "\\section*{Interfaces}");
os.println("\\" + sectionLevels[1] + "*{Interfaces}"); os.println("\\" + sectionLevels[1] + "*{Interfaces}");
interfaceHierachy.printTree(root, overviewindent); interfaceHierachy.printTree(root, overviewindent);
} }
@@ -980,11 +905,7 @@ public class TeXDoclet extends Doclet {
} }
} }
if (exceptionHierachy.root.size() != 0) { if (exceptionHierachy.root.size() != 0) {
// (S.M. modification)
// os.println( "\\section*{Exceptions}");
os.println("\\" + sectionLevels[1] + "*{Exceptions}"); os.println("\\" + sectionLevels[1] + "*{Exceptions}");
exceptionHierachy.printTree(root, overviewindent); exceptionHierachy.printTree(root, overviewindent);
} }
@@ -998,11 +919,7 @@ public class TeXDoclet extends Doclet {
} }
} }
if (errorHierachy.root.size() != 0) { if (errorHierachy.root.size() != 0) {
// (S.M. modification)
// os.println( "\\section*{Errors}");
os.println("\\" + sectionLevels[1] + "*{Errors}"); os.println("\\" + sectionLevels[1] + "*{Errors}");
errorHierachy.printTree(root, overviewindent); errorHierachy.printTree(root, overviewindent);
} }
@@ -1019,18 +936,11 @@ public class TeXDoclet extends Doclet {
* Vector of the classes to be laid out. * Vector of the classes to be laid out.
*/ */
static void layoutClasses(String type, Vector classes) { static void layoutClasses(String type, Vector classes) {
// (S.M. modification)
// if ( classes.size() > 0 ) {
// os.print("\\section{" );
// os.print( type );
// os.println( "}{" );
// }
for (int i = 0; i < classes.size(); ++i) { for (int i = 0; i < classes.size(); ++i) {
ClassDoc cd = (ClassDoc) classes.elementAt(i); ClassDoc cd = (ClassDoc) classes.elementAt(i);
// os.println( // os.println(
// "\\gdef\\classname{"+HTMLtoLaTeXBackEnd.fixText(cd.name())+"}" ); // "\\gdef\\classname{"+HTMLtoLaTeXBackEnd.fixText(cd.name())+"}" );
// (S.M. modification)
os.print("\\" + sectionLevels[1] + "{"); os.print("\\" + sectionLevels[1] + "{");
String mtype = "Class"; String mtype = "Class";
@@ -1051,8 +961,6 @@ public class TeXDoclet extends Doclet {
+ "}"); + "}");
} }
} }
// os.println(
// ""+BOLD+" {\\it "+mtype+"} "+HTMLtoLaTeXBackEnd.fixText(cd.name())+"}}{");
os.println(mtype + " " + HTMLtoLaTeXBackEnd.fixText(cd.name()) os.println(mtype + " " + HTMLtoLaTeXBackEnd.fixText(cd.name())
+ "}{"); + "}{");
if (useHr) { if (useHr) {
@@ -1081,14 +989,8 @@ public class TeXDoclet extends Doclet {
os.println(" \\end{list}"); os.println(" \\end{list}");
} }
// os.println( "\\"+sectionLevels[2]+"{Declaration}{" );
// os.println(
// "\\fcolorbox{black}{Light}{\\parbox[s]{.98\\hsize}{");
// os.print(
// "\\small "+HTMLtoLaTeXBackEnd.fixText(cd.modifiers())+" " );
os.println("\\" + sectionLevels[2] + "{Declaration}{"); os.println("\\" + sectionLevels[2] + "{Declaration}{");
// os.println(
// "\\fcolorbox{black}{Light}{\\parbox[s]{.98\\hsize}{");
os.print("\\small " + HTMLtoLaTeXBackEnd.fixText(cd.modifiers()) os.print("\\small " + HTMLtoLaTeXBackEnd.fixText(cd.modifiers())
+ " "); + " ");
if (cd.isInterface() == false) { if (cd.isInterface() == false) {
@@ -1104,15 +1006,11 @@ public class TeXDoclet extends Doclet {
ClassDoc intf[] = cd.interfaces(); ClassDoc intf[] = cd.interfaces();
if (intf.length > 0) { if (intf.length > 0) {
// os.println( "\\\\ "+BOLD+" implements} " );
// ----- (S.M. modification) Bug fixed !
// interfaces never implement something !
if (cd.isInterface() == false) { if (cd.isInterface() == false) {
os.println("\\\\ " + BOLD + " implements} "); os.println("\\\\ " + BOLD + " implements} ");
} else { } else {
os.println("\\\\ " + BOLD + " extends} "); os.println("\\\\ " + BOLD + " extends} ");
} }
// ----- (S.M. modification end)
for (int j = 0; j < intf.length; ++j) { for (int j = 0; j < intf.length; ++j) {
ClassDoc in = intf[j]; ClassDoc in = intf[j];
String nm; String nm;
@@ -1128,7 +1026,6 @@ public class TeXDoclet extends Doclet {
os.print(HTMLtoLaTeXBackEnd.fixText(nm)); os.print(HTMLtoLaTeXBackEnd.fixText(nm));
} }
} }
// os.println("}}}");
os.println("}"); os.println("}");
ExecutableMemberDoc[] mems; ExecutableMemberDoc[] mems;
FieldDoc[] flds; FieldDoc[] flds;
@@ -1152,13 +1049,6 @@ public class TeXDoclet extends Doclet {
} }
} }
// if (!subclasses.equals("")) {
// os.println("\\"+sectionLevels[2]+"{All known subclasses}{" +
// subclasses +
// "}");
// }
// ----- (S.M. modification) Bug fixed !
// interfaces never have subclasses, they have subinterfaces !
if (cd.isInterface()) { if (cd.isInterface()) {
if (!subclasses.equals("")) { if (!subclasses.equals("")) {
os.println("\\" + sectionLevels[2] os.println("\\" + sectionLevels[2]
@@ -1170,7 +1060,6 @@ public class TeXDoclet extends Doclet {
+ "{All known subclasses}{" + subclasses + "}"); + "{All known subclasses}{" + subclasses + "}");
} }
} }
// ----- (S.M. modification end)
String subintf = ""; String subintf = "";
String implclasses = ""; String implclasses = "";
@@ -1205,14 +1094,6 @@ public class TeXDoclet extends Doclet {
} }
} }
// (S.M. modification)
// Because of the correction above, the subinterfaces are
// already printed !
// if (!subintf.equals(""))
// os.println("\\"+sectionLevels[2]+"{All known subinterfaces}{"
// +
// subintf + "}");
if (!implclasses.equals("")) { if (!implclasses.equals("")) {
os.println("\\" + sectionLevels[2] os.println("\\" + sectionLevels[2]
+ "{All classes known to implement interface}{" + "{All classes known to implement interface}{"
@@ -1261,19 +1142,11 @@ public class TeXDoclet extends Doclet {
printMembers(cd, mems, true); printMembers(cd, mems, true);
os.println("}"); os.println("}");
} }
// (S.M. modification)
//
// if (inherited == false) {
// os.println( "\\hide{inherited}{" );
// }
if (inherited == true) { if (inherited == true) {
boolean yet = false; boolean yet = false;
// (S.M. modification) cd.superclass() will always return null
// for interfaces
// ??!
// so we handle it specially
if (!cd.isInterface()) { if (!cd.isInterface()) {
ClassDoc par = cd.superclass(); ClassDoc par = cd.superclass();
@@ -1283,51 +1156,6 @@ public class TeXDoclet extends Doclet {
printInherited(par); printInherited(par);
// boolean members = false;
//
// MemberDoc[] inheritedmembers = new MemberDoc[par
// .fields().length + par.methods().length];
// for (int k = 0; k < par.fields().length; k++) {
// inheritedmembers[k] = par.fields()[k];
// members = true;
// }
// for (int k = 0; k < par.methods().length; k++) {
// inheritedmembers[k + par.fields().length] = par
// .methods()[k];
// members = true;
// }
//
// // (S.M. modification) print only if members
// available (
// // for instance in case of a not correct set
// classpath
// // members are missed)
// if (members) {
// os.print("\\" + sectionLevels[2] + "{");
// // (S.M. modification) do not user true type and do
// // not print full name here
// // in the section heading
// // this produces an ugly view in the Contents ...
// //
// os.print("Members inherited from class "+TRUETYPE+""
// os.print("Members inherited from class {"
// + HTMLtoLaTeXBackEnd.fixText(
// // par.qualifiedName()
// par.name())
// + "} \\textnormal{\\small");
// printRef(par.containingPackage(), par.name(), null);
// os.println("}}{");
// os.println("{\\small ");
// // (S.M. modification)
// // ... but print here the full name including the
// // package
// os.println("(Fully qualified name: "
// + par.qualifiedName() + ")");
//
// printinheritedMembers(par, inheritedmembers, false);
//
// os.println("}}");
// }
par = par.superclass(); par = par.superclass();
} }
@@ -1345,64 +1173,15 @@ public class TeXDoclet extends Doclet {
printInherited(par); printInherited(par);
// boolean members = false;
//
// MemberDoc[] inheritedmembers = new MemberDoc[par
// .fields().length + par.methods().length];
// for (int k = 0; k < par.fields().length; k++) {
// inheritedmembers[k] = par.fields()[k];
// members = true;
// }
// for (int k = 0; k < par.methods().length; k++) {
// inheritedmembers[k + par.fields().length] = par
// .methods()[k];
// members = true;
// }
//
// // (S.M. modification) print only if members
// available (
// // if class not found because classpath not correctly
// // set, they would be missed)
// if (members) {
// os.print("\\" + sectionLevels[2] + "{");
// //
// os.println("Members inherited from class "+TRUETYPE+""+
// //
// HTMLtoLaTeXBackEnd.fixText(par.qualifiedName())+"}}{");
// // os.println("\\par{\\small " );
// // printRef( par.containingPackage(), par.name(),
// // null );
// os.print("Members inherited from class "+TRUETYPE+""
// + HTMLtoLaTeXBackEnd.fixText(par
// .qualifiedName())
// + "} \\textnormal{\\small");
// printRef(par.containingPackage(), par.name(), null);
// os.println("}}{");
// os.println("{\\small ");
//
// printinheritedMembers(par, inheritedmembers, false);
//
// os.println("}}");
// }
} }
} }
} }
// (S.M. modification)
//
// if ( inherited == false ) {
// os.println("}");
// }
os.println("}"); os.println("}");
// (S.M. modification)
// os.print("\\newpage" ); // os.print("\\newpage" );
} }
// (S.M. modification)
// if ( classes.size() > 0 ) {
// os.println("}");
// }
} }
/** /**
@@ -1700,9 +1479,6 @@ public class TeXDoclet extends Doclet {
+ HTMLtoLaTeXBackEnd.fixText(mem.name() + mem.flatSignature()) + HTMLtoLaTeXBackEnd.fixText(mem.name() + mem.flatSignature())
+ "}"); + "}");
// (S.M. modification)
// If including the output this would result in hundreds of undefull
// boxes ??!
if (hyperref) { if (hyperref) {
if (copiedTo == null) { if (copiedTo == null) {
os.print("\\hypertarget{" os.print("\\hypertarget{"
@@ -1714,8 +1490,7 @@ public class TeXDoclet extends Doclet {
+ copiedTo.signature())) + "}{"); + copiedTo.signature())) + "}{");
} }
} }
// (S.M. modification)
// os.print("\\membername{"+HTMLtoLaTeXBackEnd.fixText(mem.name())+"}");
os.print(BOLD + " " + HTMLtoLaTeXBackEnd.fixText(mem.name()) + "}\\\\"); os.print(BOLD + " " + HTMLtoLaTeXBackEnd.fixText(mem.name()) + "}\\\\");
if (hyperref) { if (hyperref) {
os.print("}"); os.print("}");
@@ -1789,15 +1564,10 @@ public class TeXDoclet extends Doclet {
if (mem.inlineTags().length > 0) { if (mem.inlineTags().length > 0) {
if (!yet) { if (!yet) {
os.println("\\begin{itemize}"); os.println("\\begin{itemize}");
// os.println("\\sld");
yet = true; yet = true;
} }
os.println("\\item{"); os.println("\\item{");
// os.println("\\sld");
if (copiedTo == null) { if (copiedTo == null) {
// os.println(
// ""+BOLD+" Description}\n \\begin{itemize}\\isep\n \\item{"
// );
os.println(BOLD + " Description}\n"); os.println(BOLD + " Description}\n");
} else { } else {
os.print(BOLD + " Description copied from "); os.print(BOLD + " Description copied from ");
@@ -1812,11 +1582,9 @@ public class TeXDoclet extends Doclet {
} }
os.print("{\\small "); os.print("{\\small ");
os.print("\\refdefined{" + refName(makeRefKey(classname)) + "}"); os.print("\\refdefined{" + refName(makeRefKey(classname)) + "}");
// os.println( "} }\n \\begin{itemize}\\isep\n \\item{" );
os.println("} }\n"); os.println("} }\n");
} }
printTags(mem.inlineTags()); printTags(mem.inlineTags());
// os.println( "}%end item\n \\end{itemize}\n}" );
os.println("\n}"); os.println("\n}");
} }
@@ -1824,18 +1592,13 @@ public class TeXDoclet extends Doclet {
if (params.length > 0) { if (params.length > 0) {
if (!yet) { if (!yet) {
os.println("\\begin{itemize}"); os.println("\\begin{itemize}");
// os.println("\\sld");
yet = true; yet = true;
} }
os.println("\\item{"); os.println("\\item{");
// os.println("\\sld");
os.println(BOLD + " Parameters}"); os.println(BOLD + " Parameters}");
// os.println("\\sld\\isep");
os.println(" \\begin{itemize}"); os.println(" \\begin{itemize}");
// os.println("\\sld\\isep");
for (int j = 0; j < params.length; ++j) { for (int j = 0; j < params.length; ++j) {
os.println(" \\item{"); os.println(" \\item{");
// os.println("\\sld");
os.print(TRUETYPE os.print(TRUETYPE
+ HTMLtoLaTeXBackEnd.fixText(params[j].parameterName()) + HTMLtoLaTeXBackEnd.fixText(params[j].parameterName())
+ "}" + " -- "); + "}" + " -- ");
@@ -1852,7 +1615,6 @@ public class TeXDoclet extends Doclet {
if (ret.length > 0) { if (ret.length > 0) {
if (!yet) { if (!yet) {
os.println("\\begin{itemize}"); os.println("\\begin{itemize}");
// os.println("\\sld");
yet = true; yet = true;
} }
os.println("\\item{" + BOLD + " Returns} -- "); os.println("\\item{" + BOLD + " Returns} -- ");
@@ -1870,12 +1632,10 @@ public class TeXDoclet extends Doclet {
if (excp.length > 0) { if (excp.length > 0) {
if (!yet) { if (!yet) {
os.println("\\begin{itemize}"); os.println("\\begin{itemize}");
// os.println("\\sld");
yet = true; yet = true;
} }
os.println("\\item{" + BOLD + " Throws}"); os.println("\\item{" + BOLD + " Throws}");
os.println(" \\begin{itemize}"); os.println(" \\begin{itemize}");
// os.println("\\sld");
for (int j = 0; j < excp.length; ++j) { for (int j = 0; j < excp.length; ++j) {
String ename = excp[j].exceptionName(); String ename = excp[j].exceptionName();
ClassDoc cdoc = excp[j].exception(); ClassDoc cdoc = excp[j].exception();
@@ -1916,7 +1676,8 @@ public class TeXDoclet extends Doclet {
} }
/** /**
* (S.M. modification) * Prints class inheritance (list of members inherited from superclasses).
*
*/ */
static void printInherited(ClassDoc par) { static void printInherited(ClassDoc par) {
boolean members = false; boolean members = false;
@@ -1932,24 +1693,14 @@ public class TeXDoclet extends Doclet {
members = true; members = true;
} }
// (S.M. modification) print only if members available (
// for instance in case of a not correct set classpath
// members are missed)
if (members) { if (members) {
os.print("\\" + sectionLevels[2] + "{"); os.print("\\" + sectionLevels[2] + "{");
// (S.M. modification) do not user true type and do // do not user true type and do not print full name here
// not print full name here
// because this produces an ugly view in the Contents section // because this produces an ugly view in the Contents section
// os.print("Members inherited from class "+TRUETYPE+"" // os.print("Members inherited from class "+TRUETYPE+""
os.print("Members inherited from class " os.print("Members inherited from class "
+ HTMLtoLaTeXBackEnd.fixText( + HTMLtoLaTeXBackEnd.fixText(par.name()) + " ");
// par.qualifiedName()
par.name()) + " ");
// par.name()) + "} \\textnormal{\\small");
os.println("}{"); os.println("}{");
// (S.M. modification)
// ... but print here the full name including the
// package and reference
os.println(TRUETYPE + par.qualifiedName() + "} {\\small "); os.println(TRUETYPE + par.qualifiedName() + "} {\\small ");
printRef(par.containingPackage(), par.name(), null); printRef(par.containingPackage(), par.name(), null);
@@ -1985,7 +1736,6 @@ public class TeXDoclet extends Doclet {
Collections.sort(l); Collections.sort(l);
Iterator itr = l.iterator(); Iterator itr = l.iterator();
// (S.M. modification)
if (shortInheritance) { if (shortInheritance) {
for (int i = 0; itr.hasNext(); ++i) { for (int i = 0; itr.hasNext(); ++i) {
@@ -2009,8 +1759,6 @@ public class TeXDoclet extends Doclet {
// Print signature // Print signature
// (S.M. modification)
// os.println("\\item{\\vskip -1.9ex " );
os.println("\\item{\\vskip -1.5ex "); os.println("\\item{\\vskip -1.5ex ");
os.print(TRUETYPE); os.print(TRUETYPE);
os.print(HTMLtoLaTeXBackEnd.fixText(mem.modifiers())); os.print(HTMLtoLaTeXBackEnd.fixText(mem.modifiers()));
@@ -2100,9 +1848,9 @@ public class TeXDoclet extends Doclet {
} }
os.println("}%end item"); os.println("}%end item");
} // end for }
os.println("\\end{itemize}"); os.println("\\end{itemize}");
} // shortInheritance }
} }
/** /**