Package scoped classes should not be included in the javadoc because they are implementation classes that you can't use or extend in the first place. Javadoc should be geared towards a user of commons-collections, not an extender or customizer who will be looking through the source anyways.

David



From: "Shapira, Yoav" <[EMAIL PROTECTED]>
Reply-To: "Jakarta Commons Developers List" <[EMAIL PROTECTED]>
To: "Jakarta Commons Developers List" <[EMAIL PROTECTED]>
Subject: RE: [collections] XxxUtils inner classes
Date: Wed, 2 Apr 2003 15:30:05 -0500



Howdy, JavaDoc by default shows only public and protected. There are switches to include package-local classes/methods and private ones, as well as switches to exclude specific public methods/classes.

However, I disgaree with Senor Colebourne's original premise.  As a
developer considering commons-collections for one of my apps, I would
like to see all the classes, as it helps me look into other parts of the
API, get reuse ideas, and judge the maturity and completeness of the
API.

Yoav Shapira
Millennium ChemInformatics


>-----Original Message----- >From: David Graham [mailto:[EMAIL PROTECTED] >Sent: Wednesday, April 02, 2003 3:23 PM >To: [EMAIL PROTECTED] >Subject: Re: [collections] XxxUtils inner classes > >AFAIK, javadoc doesn't include package scoped classes or at least there's a >flag to disable. Breaking out the classes would reduce the complexity of >maintaining the codebase far more than it would hurt. Classes with >thousands of lines of code need to be refactored. > >David > > > >>From: "Stephen Colebourne" <[EMAIL PROTECTED]> >>Reply-To: "Jakarta Commons Developers List" >><[EMAIL PROTECTED]> >>To: "Jakarta Commons Developers List" <[EMAIL PROTECTED]> >>Subject: Re: [collections] XxxUtils inner classes >>Date: Wed, 2 Apr 2003 21:21:04 +0100 >> >>In an ideal world (ie. a fresh start for [collections]) I would create >>subpackages. I guess I'm a natural grouper, and find javas lack of a >>subpackage scope very annoying. >> >>Its too late for [collections], and one package must remain. >> >>I remain unconvinced about the need to break out the inner classes though. >>I >>do judge the complexity of an API by the number of visible classes in the >>javadoc/ real java files. Even as package private I would find these many >>classes distinctly annoying, and they would get in the way of me >>understanding the API. I'm -0.5 at present on breaking out the inner >>classes. >> >>Stephen >> >>----- Original Message ----- >>From: "Alex Chaffee / Purple Technology" <[EMAIL PROTECTED]> >>To: "Jakarta Commons Developers List" <[EMAIL PROTECTED]> >>Sent: Wednesday, April 02, 2003 9:03 PM >>Subject: Re: [collections] XxxUtils inner classes >> >> >> > On Wed, Apr 02, 2003 at 11:13:00AM -0700, David Graham wrote: >> > > I see no problem with using just 1 package >>org.apache.commons.collections. >> > > Sub-packages are not needed and violate the "package is the unit of >>release" >> > > principle. >> > >> > Yes. Subpackaging bad. import org.apache.commons.collections.* good. >> > >> > - A >> > >> > >> > --------------------------------------------------------------------- >> > To unsubscribe, e-mail: [EMAIL PROTECTED] >> > For additional commands, e-mail: [EMAIL PROTECTED] >> > >> >> >>--------------------------------------------------------------------- >>To unsubscribe, e-mail: [EMAIL PROTECTED] >>For additional commands, e-mail: [EMAIL PROTECTED] >> > > >_________________________________________________________________ >Add photos to your messages with MSN 8. Get 2 months FREE*. >http://join.msn.com/?page=features/featuredemail > > >--------------------------------------------------------------------- >To unsubscribe, e-mail: [EMAIL PROTECTED] >For additional commands, e-mail: [EMAIL PROTECTED]




This e-mail, including any attachments, is a confidential business communication, and may contain information that is confidential, proprietary and/or privileged. This e-mail is intended only for the individual(s) to whom it is addressed, and may not be saved, copied, printed, disclosed or used by anyone else. If you are not the(an) intended recipient, please immediately delete this e-mail from your computer system and notify the sender. Thank you.



--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]



_________________________________________________________________
Protect your PC - get McAfee.com VirusScan Online http://clinic.mcafee.com/clinic/ibuy/campaign.asp?cid=3963



--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]



Reply via email to