• Open Menu Close Menu
  • Apple
  • Shopping Bag
  • Apple
  • Mac
  • iPad
  • iPhone
  • Watch
  • TV
  • Music
  • Support
  • Search apple.com
  • Shopping Bag

Lists

Open Menu Close Menu
  • Terms and Conditions
  • Lists hosted on this site
  • Email the Postmaster
  • Tips for posting to public mailing lists
Re: Generating Javadocs with links to existing WO Javadocs
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Generating Javadocs with links to existing WO Javadocs


  • Subject: Re: Generating Javadocs with links to existing WO Javadocs
  • From: Paul Hoadley <email@hidden>
  • Date: Fri, 28 Nov 2008 20:32:59 +1030

Just for the record...

On 19/11/2008, at 2:47 PM, Paul Hoadley wrote:

I want to generate some HTML Javadocs for several projects. Ideally, I'd like to have my @link tags that point to WO (and Wonder, for that matter) classes to resolve to existing online documentation. I want this to work from the command line eventually (to run as a cron job), but even an Eclipse-based solution would help.

From the command line I've tried this:

javadoc -sourcepath Sources -d doc -linkoffline http://developer.apple.com/documentation/MacOSXServer/Reference/WO54_Reference/ wo-packages -subpackages net

Where wo-packages was a directory into which I put a hand-built package-list for the WO packages, since I couldn't seem to get that list from below the developer.apple.com URL above. This fails with (among other things) a slew of ClassCastExceptions, which look like they're related to annotations,

These were related to annotations, and it was because I didn't have the JAR containing my declaration of those (custom) annotations in the classpath for javadoc.


and a "Tag @link: reference not found" for every external link.

From Eclipse, all the WO-related JARs are flagged "not configured", and I see no option for linking to existing external documentation.

Again, I can probably get there eventually, but is anyone doing this already? I must be missing something obvious.

In the end, I used the Ant javadoc task and copied the basics from Wonder:


http://wonder.svn.sourceforge.net/viewvc/wonder/trunk/Wonder/Build/build/build-doc.xml?revision=7381&view=markup

In particular, the 'api' target at the end, though I seemed to need slightly different syntax for the Apple WO link:

<link href="${wo54.api.href}" offline="true" packagelistLoc="$ {wo54.packagelistLoc}"/>

where ${wo54.packagelistLoc} was the name of the directory containing the package-list that I borrowed from Wonder. It didn't work for me unless I specified offline="true".


-- Paul.

w  http://logicsquad.net/
h  http://paul.hoadley.name/


_______________________________________________ Do not post admin requests to the list. They will be ignored. Webobjects-dev mailing list (email@hidden) Help/Unsubscribe/Update your Subscription: This email sent to email@hidden
References: 
 >Generating Javadocs with links to existing WO Javadocs (From: Paul Hoadley <email@hidden>)

  • Prev by Date: Re: About instance's integrity. (was Re: Webobjects-dev Digest, Vol 5, Issue 1141)
  • Next by Date: Localization problem
  • Previous by thread: Generating Javadocs with links to existing WO Javadocs
  • Next by thread: Programmatic URL are Problematic
  • Index(es):
    • Date
    • Thread