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

[Jacob Wisor]

On 01/28/2014 03:35 PM, Jiri Vanek wrote:
> On 01/27/2014 07:29 PM, Jacob Wisor wrote:
>> On 01/27/2014 03:22 PM, Jiri Vanek wrote:
>>> On 01/27/2014 05:43 AM, Jacob Wisor wrote:
>>>> [...]
>>>   /**
>>> - *
>>> - * @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.
>>
>> Why is that? A lot of classes have @author doctags. It does not denote
>> ownership. It is just a hint
>> as to whom to turn for questions about the code in the future.
>> If they are absolutely not allowed, well then all other existing @author
>> doctags need to be stripped
>> too. And, that's kind of mind boggling.
>
> hmhhm. The oldest classes (original NETX ones) have author and email-to. Since
> icedtea take cover over project, the author and email-to become obsoleted (as
> distro-pkg-dev is email now)
>
> I would like to remove, just what was in this hunk - me as Author in this class,
> as I joined the team long after icedtea-web was under icedtea.
>
> If you do have some concerns about my arguments here. Please keep this hunk as
> you wish.

I have removed your @author doctags, as you requested. Although, from a legal 
stand point this not necessary, even rather counter indicated. Since IcedTea-Web 
is licensed under the GPL, documenting authorship is mandatory. No one (except 
an original author himself) may drop nor request to drop authorship from GPL 
code, even after modifying the source code. The GPL is *not* public domain. So, 
any enforcing, mandating, or encouraging policy (as IcedTea-Web's web page does) 
to relinquish or hide authorship is a violation of the GPL. Yes, the 
IcedTea-Web's repo operator may deny any contributions but if he decides to 
accept it he must not request to relinquish nor remove author notices from that 
contribution or the merged code.

So in general, adding @author doctags is okay. IcedTea-Web's contribution policy 
should probably be rather altered to accept @author doctags in the sense that 
they denote not only authorship but primarily denote people to turn to for 
questions in the future.

>>> 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.
>>
> hhmm. I have just tested. I have not spotted the "strange behavior" which I had
> during development.
> So its probably ok.... Do you mind to add this hunk as separate chnageset?

Okay, I have put it into a separate changeset.

Thank you for reviewing.

Jacob