From: Tom Anderson on
On Mon, 22 Feb 2010, markspace wrote:

> In my opinion, the Java doc is defective for not mentioning these
> methods. It should copy-and-paste the above section into the Java doc
> for the Enum class, so that the information is ready-to-hand for anyone
> looking at the Enum methods.

If you make javadoc for the enum itself, does that include the synthetic
methods? That seems like the right place for it to me - Colours.values()
is a method of the Colours type, not Enum.

tom

--
Tristan Tzara offered to create a poem on the spot by pulling words at
random from a hat. A riot ensued and Andre Breton expelled Tzara from
the movement.
From: John B. Matthews on
In article <alpine.DEB.1.10.1002231317420.8425(a)urchin.earth.li>,
Tom Anderson <twic(a)urchin.earth.li> wrote:

> On Mon, 22 Feb 2010, markspace wrote:
>
> > In my opinion, the Java doc is defective for not mentioning these
> > methods. It should copy-and-paste the above section into the Java
> > doc for the Enum class, so that the information is ready-to-hand
> > for anyone looking at the Enum methods.
>
> If you make javadoc for the enum itself, does that include the
> synthetic methods? That seems like the right place for it to me -
> Colours.values() is a method of the Colours type, not Enum.

That makes sense, e.g.

<http://java.sun.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html>
<http://robotchase.sourceforge.net/org/gcs/robot/Key.html>

--
John B. Matthews
trashgod at gmail dot com
<http://sites.google.com/site/drjohnbmatthews>
From: Tom Anderson on
On Tue, 23 Feb 2010, John B. Matthews wrote:

> In article <alpine.DEB.1.10.1002231317420.8425(a)urchin.earth.li>,
> Tom Anderson <twic(a)urchin.earth.li> wrote:
>
>> On Mon, 22 Feb 2010, markspace wrote:
>>
>>> In my opinion, the Java doc is defective for not mentioning these
>>> methods. It should copy-and-paste the above section into the Java
>>> doc for the Enum class, so that the information is ready-to-hand
>>> for anyone looking at the Enum methods.
>>
>> If you make javadoc for the enum itself, does that include the
>> synthetic methods? That seems like the right place for it to me -
>> Colours.values() is a method of the Colours type, not Enum.
>
> That makes sense, e.g.
>
> <http://java.sun.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html>
> <http://robotchase.sourceforge.net/org/gcs/robot/Key.html>

That's the bunny!

tom

--
an expertly crafted mix of practical decision-making and drunken shouting
From: Marc van Dongen on
On Feb 23, 2:00 pm, "John B. Matthews" <nos...(a)nospam.invalid> wrote:


> > If you make javadoc for the enum itself, does that include the
> > synthetic methods? That seems like the right place for it to me -
> > Colours.values() is a method of the Colours type, not Enum.
>
> That makes sense, e.g.
>
> <http://java.sun.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html>
> <http://robotchase.sourceforge.net/org/gcs/robot/Key.html>

Thanks. Good to see it's there.

Regards,


Marc van Dongen
From: markspace on
Tom Anderson wrote:
> On Mon, 22 Feb 2010, markspace wrote:
>
>> In my opinion, the Java doc is defective for not mentioning these
>> methods. It should copy-and-paste the above section into the Java doc
>> for the Enum class, so that the information is ready-to-hand for
>> anyone looking at the Enum methods.
>
> If you make javadoc for the enum itself, does that include the synthetic
> methods? That seems like the right place for it to me - Colours.values()
> is a method of the Colours type, not Enum.


It still should be documented in the super type, imo, since the method
is generated. Is see the distinction, but it would be very convenient
to have it in the Java doc for Enum.