Path: csiph.com!v102.xanadu-bbs.net!xanadu-bbs.net!feeder.erje.net!eu.feeder.erje.net!usenet.ukfsn.org!not-for-mail From: Martin Gregorie Newsgroups: comp.lang.java.programmer Subject: Re: Javadoc rethinking? Date: Wed, 16 Jan 2013 20:14:50 +0000 (UTC) Organization: UK Free Software Network Lines: 29 Message-ID: References: <3b10d0bb-0307-4365-b762-d619fd3c608b@googlegroups.com> <50f6cebb$0$285$14726298@news.sunsite.dk> NNTP-Posting-Host: 84.45.235.129 Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Trace: localhost.localdomain 1358367290 5924 84.45.235.129 (16 Jan 2013 20:14:50 GMT) X-Complaints-To: usenet@localhost.localdomain NNTP-Posting-Date: Wed, 16 Jan 2013 20:14:50 +0000 (UTC) User-Agent: Pan/0.139 (Sexual Chocolate; GIT bf56508 git://git.gnome.org/pan2) Xref: csiph.com comp.lang.java.programmer:21446 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 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. -- martin@ | Martin Gregorie gregorie. | Essex, UK org |