some outdated docs cleanup

examples/example1_complete_report/createDocs.sh

@@ -6,7 +6,6 @@ javadoc -docletpath ../../target/TeXDoclet.jar \
 	-doclet org.stfm.texdoclet.TeXDoclet \
 	-tree \
 	-hyperref \
-	-texinit texdoclet_include/preamble.tex \
 	-imagespath ".." \
 	-output texdoclet_output/TeXDoclet.tex \
 	-title "TeXDoclet Java Documentation" \

src/main/java/org/stfm/texdoclet/HTMLtoLaTeXBackEnd.java

@@ -69,12 +69,12 @@ public class HTMLtoLaTeXBackEnd extends HTMLEditorKit.ParserCallback {
 	/**
 	 * Constructs a new instance.
 	 * 
-	 * @param StringBuffer
+	 * @param stringBuffer
 	 *            The <CODE>StringBuffer</CODE> where the translated HTML is
 	 *            appended.
 	 */
-	public HTMLtoLaTeXBackEnd(StringBuffer ret) {
+	public HTMLtoLaTeXBackEnd(StringBuffer stringBuffer) {
-		this.ret = ret;
+		this.ret = stringBuffer;
 	}
 
 	/**
@@ -663,7 +663,7 @@ public class HTMLtoLaTeXBackEnd extends HTMLEditorKit.ParserCallback {
 	 * Converts a HTML string into <TEX txt="\LaTeX{}">LaTeX</TEX> using an
 	 * instance of <CODE>HTMLtoLaTeXBackEnd</CODE>.
 	 * 
-	 * @returns The converted string.
+	 * @return The converted string.
 	 */
 	public static String fixText(String str) {
 		// System.out.println("fixText: " + str);

src/main/java/org/stfm/texdoclet/TableInfo.java

@@ -104,15 +104,11 @@ public class TableInfo {
 	 * Constructs a new table object and starts processing of the table by
 	 * scanning the <code>&lt;table&gt;</code> passed to count columns.
 	 * 
-	 * @param p
+	 * //@param p // properties found on the <code>&lt;table&gt;</code> tag
-	 *            properties found on the <code>&lt;table&gt;</code> tag
+	 * //@param ret // the result buffer that will contain the output //@param
-	 * @param ret
+	 * table // the input string that has the entire table definition in it.
-	 *            the result buffer that will contain the output
+	 * //@param off // the offset into <code>&lt;table&gt;</code> where scanning
-	 * @param table
+	 * // should start
-	 *            the input string that has the entire table definition in it.
-	 * @param off
-	 *            the offset into <code>&lt;table&gt;</code> where scanning
-	 *            should start
 	 */
 	public StringBuffer startTable(StringBuffer org, MutableAttributeSet attrSet) {
 		originalBuffer = org;
@@ -165,9 +161,6 @@ public class TableInfo {
 	/**
 	 * Ends the table, closing the last row as needed
 	 * 
-	 * @param ret
-	 *            The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
-	 *            into.
 	 */
 	public StringBuffer endTable() {
 		originalBuffer.append("\n% Table #" + tblno + "\n\\begin{center}\n");
@@ -217,11 +210,8 @@ public class TableInfo {
 	/**
 	 * Starts a new column, possibly closing the current column if needed
 	 * 
-	 * @param ret
+	 * //@param ret The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
-	 *            The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
+	 * into. //@param p the properties from the <code>&lt;td&gt;</code> tag
-	 *            into.
-	 * @param p
-	 *            the properties from the <code>&lt;td&gt;</code> tag
 	 */
 	public void startCol(MutableAttributeSet attrSet) {
 		int span = hasNumAttr(HTML.Attribute.COLSPAN, attrSet);
@@ -271,11 +261,8 @@ public class TableInfo {
 	 * Starts a new Heading column, possibly closing the current column if
 	 * needed. A Heading column has a Bold Face font directive around it.
 	 * 
-	 * @param ret
+	 * //@param ret The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
-	 *            The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
+	 * into. //@param p The properties from the <code>&lt;th&gt;</code> tag
-	 *            into.
-	 * @param p
-	 *            The properties from the <code>&lt;th&gt;</code> tag
 	 */
 	public void startHeadCol(MutableAttributeSet attrSet) {
 		startCol(attrSet);
@@ -285,8 +272,7 @@ public class TableInfo {
 	/**
 	 * Ends the current column.
 	 * 
-	 * @param ret
+	 * //@param ret The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
-	 *            The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
 	 * into.
 	 */
 	public void endCol() {
@@ -300,10 +286,8 @@ public class TableInfo {
 	/**
 	 * Starts a new row, possibly closing the current row if needed
 	 * 
-	 * @param ret
+	 * //@param ret The output buffer to put <TEX txt="\LaTeX{}">LaTeX</TEX>
-	 *            The output buffer to put <TEX txt="\LaTeX{}">LaTeX</TEX> into.
+	 * into. //@param p The properties from the <code>&lt;tr&gt;</code> tag
-	 * @param p
-	 *            The properties from the <code>&lt;tr&gt;</code> tag
 	 */
 	public void startRow(MutableAttributeSet attrSet) {
 		if (rowcnt == 0) {
@@ -318,8 +302,7 @@ public class TableInfo {
 	/**
 	 * Ends the current row.
 	 * 
-	 * @param ret
+	 * // @param ret The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
-	 *            The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
 	 * into.
 	 */
 	public void endRow() {