[rfc][icedtea-web] Javadoc, XHTML conformance, and formatting cleanup

[Jiri Vanek]

On 01/27/2014 05:43 AM, Jacob Wisor wrote:
> Hello,
>
> The subject says it. I was especially bothered by javadoc throwing @doctag errors and warnings as
> well as its output not being XML conform. Many HTML elements that have gathered over time in the
> source code have not been XHTML conform hence causing javadoc's output also not being XML conform. I
> think this patch could serve as an improvement to the overall quality of the source code as the
> world transitions to strictly XML conforming data. So, the HTML documents generated by javadoc
> should be fully conforming to XML, hence XHTML documents now. Yey! :-)
>
> Jacob


Wou. Thats the patch.


Have the generated javadoc passed some check after the improvements? If so What it was, I would 
include it into some tests-javadoc target...


Few comments to changes:

You are using

+ * <pre><code>
   * FirefoxPreferencesParser p = new FirefoxPreferencesParser(prefsFile);
   * p.parse();
   * Map&lt;String,String&gt; prefs = p.getPreferences();
   * System.out.println("blink allowed: " + prefs.get("browser.blink_allowed"));
- * </pre>
+ * </code></pre>

pattern few times - Whats the benefitof it? I would say pre xor code is enough, isnt it?



  /**
- *
- * @author jvanek
+ * @author <a href="mailto:Jiri%20Vanek%20&lt;jvanek at redhat.com&gt;">Jiri Vanek</a>
   */

Ugh. Author tag is not allowed. Please just remove instead of fix.


diff -r efa527f74184 netx/net/sourceforge/jnlp/util/logging/ConsoleOutputPaneModel.java
--- a/netx/net/sourceforge/jnlp/util/logging/ConsoleOutputPaneModel.java
+++ b/netx/net/sourceforge/jnlp/util/logging/ConsoleOutputPaneModel.java
@@ -188,8 +188,8 @@
              }
              String line = (createLine(messageWithHeader));
              if (mark) {
-                line = line.replaceAll("\n", "<br>\n");
-                line = line.replaceAll("  ", "&nbsp; ");//small trick, html is reducting row of 
sapces to single space. This handles it and stimm allow line wrap
+                line = line.replaceAll("\n", "<br/>\n");
+                line = line.replaceAll("  ", "&nbsp; ");//small trick, html is reducting row of 
spaces to single space. This handles it and stimm allow line wrap
                  line = line.replaceAll("\t", "&nbsp;&nbsp;&nbsp;&nbsp;");

This is not possible. Unluckily the java html parser do not survive <br/>. Please remove this hunk.

After fixing above. Looks ok.


Is backport to 1.4 possible? As the cnages are 99% really javadoc related, I do not insists. My 
motivation  to backport have only one  valaid point - The refactoring is changing  backporting and 
forwardporting  from automatic level to manual one.  Unless you have something against, do you mind 
to backport valid parts after  1.4.2 release?

J.