Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.java.programmer > #21449

Re: Javadoc rethinking?

Show all headers | View raw

On Wed, 16 Jan 2013 20:14:50 +0000, Martin Gregorie wrote:

> On Wed, 16 Jan 2013 11:00:58 -0500, Arne Vajhøj wrote:
> 
>> On 1/16/2013 10:38 AM, bob smith wrote:
>>> Am I the only one who thinks that maybe there ought to be some
>>> improvements to the Javadoc process?
>>>
>>> I was just looking at a Javadoc for a DatePickerDialog, and it seemed
>>> like it was missing something…  that something was an image of an
>>> example of the dialog.  I think that would have been very helpful.
>>>
>>> However, Javadocs don't support images, and it is not necessarily good
>>> for the crucial documentation to be mingled with the code.
>> 
>> JavaDoc support HTML tags and I would assume they support IMG tag??
>>
> Yes, the Javadocs docs say you can put both HTML and images in the doc-
> files directory.
> 
> The only I have is that the docs say you should not put a <title>
> section in package.html because this causes a conflict with HTML-tidy.
> Fortunately, you can ignore this: running "tidy -m ..." generates a
> <title> section which does not cause any problems with javadocs - at
> least, none that I can see.
>
Sorry: that should read:

"The only niggle I have is that the Javadocs docs say you should not put 
a <title> section in package.html because this causes a conflict with 
HTML-tidy."


-- 
martin@   | Martin Gregorie
gregorie. | Essex, UK
org       |

Back to comp.lang.java.programmer | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

Javadoc rethinking? bob smith <bob@coolfone.comze.com> - 2013-01-16 07:38 -0800
  Re: Javadoc rethinking? Arne Vajhøj <arne@vajhoej.dk> - 2013-01-16 11:00 -0500
    Re: Javadoc rethinking? Martin Gregorie <martin@address-in-sig.invalid> - 2013-01-16 20:14 +0000
      Re: Javadoc rethinking? Martin Gregorie <martin@address-in-sig.invalid> - 2013-01-16 22:11 +0000
        Re: Javadoc rethinking? Lew <lewbloch@gmail.com> - 2013-01-16 17:00 -0800
          Re: Javadoc rethinking? Martin Gregorie <martin@address-in-sig.invalid> - 2013-01-17 01:25 +0000
  Re: Javadoc rethinking? Steven Simpson <ss@domain.invalid> - 2013-01-16 18:49 +0000
    Re: Javadoc rethinking? "John B. Matthews" <nospam@nospam.invalid> - 2013-01-17 00:35 -0500
  Re: Javadoc rethinking? Jukka Lahtinen <jtfjdehf@hotmail.com.invalid> - 2013-01-16 21:18 +0200
  Re: Javadoc rethinking? Roedy Green <see_website@mindprod.com.invalid> - 2013-01-16 23:33 -0800

csiph-web