Re: maxEntries in contents()

Gregg Wonderly wrote:
> John McClain - Sun Microsystems, Inc. wrote:
>> One idea that does appeal to me is writing some sort of companion
>> document to the JavaSpace05/MatchSet/AvailabilityEvent JavaDoc that can
>> include non-normative text, be less precise, and more user oriented. I
>> suspect it would focus on the expected usage models. Not sure what would
>> be the best way to make this new document visible (then there is the
>> time problem too)
>
> One idea that appeals to me is to put the non-normative text into the
> javadocs
> and have them refer, by clickable link to the appropriate
> "specification" text.
>  Programmers need to have informative, descriptive text in the JavaDocs
> to aid
> in making timely decisions about how to use it.  If we have to consult
> external
> documents to get understandable text, then I don't think there is a
> reason for
> the JavaDoc to exist separate from a specification.
>

I prefer the spec as javadoc and why not have the non-normative text as
another custom tag, in the same way as the current implementation
details are part of the JTSK javadoc.

As proper IDEs can generate the javadoc on demand when they have the
source code available (Ctrl Q e.g. in IntelliJ) or provide the ability
to link in external javadoc I think javadoc is the place to put the stuff.

And with regard to John's remark about time, well there is a solution to
the lack of time problem especially in what some people might call the
participation age ...
--
Mark

===========================================================================
To unsubscribe, send email to [email protected] and include in the body
of the message "signoff JAVASPACES-USERS".  For general help, send email to
[email protected] and include in the body of the message "help".

To view past JAVASPACES-USERS postings, please see:
http://archives.java.sun.com/archives/javaspaces-users.html

JDC members can download the JavaSpaces(tm) Technology from:
http://developer.java.sun.com/developer/products/jini/