Yeah, I try to write an overall "how do you use it" document for the package.html with smaller chunks in the individual class javadoc.
ms On Jan 25, 2010, at 6:45 PM, Joe Little wrote: > Searching for things within Confluence is still problematic, but I do > believe its still the best place for showing _how_ to use things in > general. I've found better explanations there on average than what I > can glean from the java docs, but mostly that's because I'm more > example-driven than one to discern usage from Java Docs. Each has > their advantages to different people. That said, if its a copy from > the java docs, then yes it should be by reference. > > I think ideally that you have all your Wonder frameworks in > Confluence, a nice intro/example page for each framework, with links > to the java docs to avoid duplication and/or outdated-ness where > possible. > > > On Mon, Jan 25, 2010 at 3:42 PM, Mike Schrag <msch...@mdimension.com> wrote: >> the great quandry of javadocs .... i wonder if this should be a symlink to >> the package.html for the bulk of this page? Maybe it should only include >> notes and comments above and beyond what appears in the javadoc? Ray is >> working on a tool that might make this process suck less. >> >> ms >> >> On Jan 25, 2010, at 6:39 PM, Joe Little wrote: >> >>> I was originally using the confluence docs.. and when that failed, >>> went to the class file docs. Both were wrong. I'll go and update the >>> confluence docs. >>> >>> http://wiki.objectstyle.org/confluence/display/WONDER/ERTaggable >>> >>> >>> On Mon, Jan 25, 2010 at 3:38 PM, Mike Schrag <msch...@mdimension.com> wrote: >>>>> not sure which docs you were looking at, but the package.html* (which i >>>>> consider to be The Docs (TM) ) looks correct: >>>> * >>>> http://webobjects.mdimension.com/hudson/job/Wonder53/javadoc/er/taggable/package-summary.html >>>> >>>> ms >>>> >> >> >> _______________________________________________ Do not post admin requests to the list. They will be ignored. Webobjects-dev mailing list (Webobjects-dev@lists.apple.com) Help/Unsubscribe/Update your Subscription: http://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com This email sent to arch...@mail-archive.com