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

Re: Javadoc rethinking?

From	Roedy Green <see_website@mindprod.com.invalid>
Newsgroups	comp.lang.java.programmer
Subject	Re: Javadoc rethinking?
Date	2013-01-16 23:33 -0800
Organization	Canadian Mind Products
Message-ID	<q2aff8p4npd85ga3mvddq8p34u30md6o4r@4ax.com> (permalink)
References	<3b10d0bb-0307-4365-b762-d619fd3c608b@googlegroups.com>

Show all headers | View raw

On Wed, 16 Jan 2013 07:38:18 -0800 (PST), bob smith
<bob@coolfone.comze.com> wrote, quoted or indirectly quoted someone
who said :

>
>I was just looking at a Javadoc for a DatePickerDialog, and it seemed like =
>it was missing something=85  that something was an image of an example of t=
>he dialog.  I think that would have been very helpful.

AMEN!   I have often wanted to illustrate layouts too.

Another feature I would like is commentary on @see to explain why that
other reference might be germane.  Or how it differs from this method.

If you start inserting entities, the Javadoc quickly becomes
unreadable to the programmer. The IDE should render it or there should
be some way to write it without entities.  Perhaps we should presume
UTF-8 for all Java source.
-- 
Roedy Green Canadian Mind Products http://mindprod.com
The first 90% of the code accounts for the first 90% of the development time.
The remaining 10% of the code accounts for the other 90% of the development 
time. 
~ Tom Cargill  Ninety-ninety Law

Back to comp.lang.java.programmer | Previous | Next — Previous 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