From d754faa13a579f457208f73b13f34457c9957cd3 Mon Sep 17 00:00:00 2001
From: stfm <stfm@doclet>
Date: Sun, 24 Mar 2013 19:24:15 +0100
Subject: [PATCH] some outdated docs cleanup

---
 .../example1_complete_report/createDocs.sh    |  1 -
 .../stfm/texdoclet/HTMLtoLaTeXBackEnd.java    |  8 ++--
 .../java/org/stfm/texdoclet/TableInfo.java    | 47 ++++++-------------
 3 files changed, 19 insertions(+), 37 deletions(-)

diff --git a/examples/example1_complete_report/createDocs.sh b/examples/example1_complete_report/createDocs.sh
index 44cd0f8..49a1b07 100755
--- a/examples/example1_complete_report/createDocs.sh
+++ b/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" \
diff --git a/src/main/java/org/stfm/texdoclet/HTMLtoLaTeXBackEnd.java b/src/main/java/org/stfm/texdoclet/HTMLtoLaTeXBackEnd.java
index f0969cd..128c655 100755
--- a/src/main/java/org/stfm/texdoclet/HTMLtoLaTeXBackEnd.java
+++ b/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) {
-		this.ret = ret;
+	public HTMLtoLaTeXBackEnd(StringBuffer stringBuffer) {
+		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);
diff --git a/src/main/java/org/stfm/texdoclet/TableInfo.java b/src/main/java/org/stfm/texdoclet/TableInfo.java
index 5020472..877074e 100755
--- a/src/main/java/org/stfm/texdoclet/TableInfo.java
+++ b/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
-	 *            properties found on the <code>&lt;table&gt;</code> tag
-	 * @param ret
-	 *            the result buffer that will contain the output
-	 * @param table
-	 *            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
+	 * //@param p // properties found on the <code>&lt;table&gt;</code> tag
+	 * //@param ret // the result buffer that will contain the output //@param
+	 * table // 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
-	 *            The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
-	 *            into.
-	 * @param p
-	 *            the properties from the <code>&lt;td&gt;</code> tag
+	 * //@param ret The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
+	 * 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
-	 *            The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
-	 *            into.
-	 * @param p
-	 *            The properties from the <code>&lt;th&gt;</code> tag
+	 * //@param ret The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
+	 * into. //@param p The properties from the <code>&lt;th&gt;</code> tag
 	 */
 	public void startHeadCol(MutableAttributeSet attrSet) {
 		startCol(attrSet);
@@ -285,9 +272,8 @@ public class TableInfo {
 	/**
 	 * Ends the current column.
 	 * 
-	 * @param ret
-	 *            The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
-	 *            into.
+	 * //@param ret The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
+	 * into.
 	 */
 	public void endCol() {
 		if (parboxed) {
@@ -300,10 +286,8 @@ public class TableInfo {
 	/**
 	 * Starts a new row, possibly closing the current row if needed
 	 * 
-	 * @param ret
-	 *            The output buffer to put <TEX txt="\LaTeX{}">LaTeX</TEX> into.
-	 * @param p
-	 *            The properties from the <code>&lt;tr&gt;</code> tag
+	 * //@param ret The output buffer to put <TEX txt="\LaTeX{}">LaTeX</TEX>
+	 * into. //@param p The properties from the <code>&lt;tr&gt;</code> tag
 	 */
 	public void startRow(MutableAttributeSet attrSet) {
 		if (rowcnt == 0) {
@@ -318,9 +302,8 @@ public class TableInfo {
 	/**
 	 * Ends the current row.
 	 * 
-	 * @param ret
-	 *            The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
-	 *            into.
+	 * // @param ret The output buffer to put <TEX txt="\LaTeXe{}">LaTeX2e</TEX>
+	 * into.
 	 */
 	public void endRow() {
 		ret.append(" \\\\");