Wednesday, April 13, 2011

Shipping API Jars Without The Associated JavaDoc: An Antipattern

I just tried out the RSA 8.0.2 release and tried to create a new SCA Project. To my surprise, I was missing any and all documentation for the org.osoa.sca* packages. What's the point of including SCA support if you don't include the corresponding JavaDoc?

Here is the solution:
  1. Highlight one of the imports
  2. Control-click / press f3 to go to the declaration
  3. Click 'Link with Editor' on the Package Explorer view
  4. Right-click->Properties / press Alt+Enter on the parent jar (org.apache.tuscany.sca.api.jar)
  5. Select 'Javadoc Location'
  6. Set the Javadoc URL to http://tuscany.apache.org/doc/javadoc/java-sca-1.6.1/sca-api/
  7. Validate the location to be sure you didn't accidentally include index.html at the end (which I always screw up)
Post a Comment