Help Help   Login Login   Home Home
Home » Language IDEs » Java Development Tools (JDT) » deploying javadoc with a plugin
deploying javadoc with a plugin [message #495938] Fri, 06 November 2009 12:48 Go to next message
John Cortell is currently offline John Cortell
Messages: 25
Registered: July 2009
Junior Member
Figured I'd rephrase the question in my previous post and see if I have better luck:

- I'm developing a plugin that contains API (classes/interfaces) that external company ACME will build against.
- I don't want to give ACME visibility to the source
- I do want ACME developers to have access to the JavaDoc
- I want those developers to automatically (without having to configure anything) have access to the JavaDoc within JDT, so that, e.g., when they hover the cursor over a method call, they see the documentation for that method. In an ACME developer's environment, my plugin will be part of the 'Plug-in Dependencies' container.

How can I package the javadoc with my plugin so this is possible? (Or, is it not possible?)

John
Report message to a moderator
Re: deploying javadoc with a plugin [message #496010 is a reply to message #495938 ] Fri, 06 November 2009 19:28 Go to previous message
John Cortell is currently offline John Cortell
Messages: 25
Registered: July 2009
Junior Member
The beauty of open source is, with a little patience (or a lot), you can usually answer your own questions--by digging into the code Smile

So, from what I can tell, there are two ways to do what I was looking for:

1. Contribute an 'org.eclipse.pde.core.javadoc' extension in your plugin. Bundle the html tree (in zipped or unzipped fashion) with your plugin. The extension lets you specify the path to the javadoc and lets you list all the plugins (by ID) that the javadoc documents

...or,

2. Create a sub-directory called "doc" at the root of the plugin directory. Put the html files (tree) in there. This approach, however, is currently broken. I've created bugzilla 294525 and submitted a patch.
Report message to a moderator
Previous Topic:error when installing Visual Editor 1.4.0
Next Topic:javamail access restriction error
Goto Forum:
  

[ Generate printable PDF ] [ Syndicate this forum (XML) ] [ RSS ]