Are there any other ideas for adding to the documentation? I have some
thoughts, but it is a bit of a grab bag. I would be open to suggestions.
- We have a @property tag, but it is extremely under-used. For
example, I went through the ERXModelGroup class and added the 63
properties that that class allows you to set that affect the behavior
of the class.
- I see a @project tag in some of the sources, but I was not sure why
it was there. There is a no class for including it in the javadoc. It
occured to me, though, that it might have been intended to provide a
place to link to the appropriate Project Wonder sources on the
sourceforge web pages. That would be cool. Of course, that is not
And, of course, there could be a list page and a nav bar link for the
'@property" tagged items also, like the Deprecated list and the
WOComponents list and the 'D2W Keys' list. But just how many things do
we want up there in the nav bar, anyways? It could get a bit ridiculous.
Also, I have something I am experimenting with. I have something that
includes Apple's javadoc (unfortunately out of date) in the same
javadoc system as the Project Wonder sources' doc. It would also let
us annotate, or add to, the javadoc that is there. So we would see
com.webobjects.eoaccess.EOModelGroup in the same javadoc. Also, we
could add info to document our over-ridden classes, like NSArray.
I have spoken with people at Apple about this in the past. They object
to people just taking their javadoc, but they may not have issues with
us including their javadoc in such a way that:
1) it is clear what text in the doc came from Apple and what did not
2) the annotations are not hostile to Apple
3) any updates that Apple ships get merged in
Frankly, I am not afraid of Apple updating the documentation too
often. I would not be surprised if the WO 5.4.2 version of the javadoc
up on Apple's site is the last update we ever see. But we can do better.
cheers - ray