Eclipse Community Forums - RDF feed
https://www.eclipse.org/forums/
Eclipse Community ForumsNeed help to integrate a vendor's Javadoc to Eclipse
https://www.eclipse.org/forums/index.php/mv/msg/452024/1005223/#msg_1005223
However, I'm currently not able to integrate it to Eclipse, which is painful, because instead of just reading the Eclipse doc popups, I have to make round-trips to my browser. Here is what it looks like in Eclipse:
After learning that the Javadoc can be defined at project and .jar level, I tried to do that, knowing that:
the javadoc folder contains a packages-list file (see attachment), which seems to sanely define the documented packages
the javadoc folder contains the typical folder/subfolder package structure, itself containing ClassName.html files. E.g. the com.matrixone.apps.domain line of my packages-list file is matched by a com/matrixone/apps/domain, containing lots of ClassName.html files
the javadoc folder doesn't contain a index.html file
When I try to define my Javadoc, the Validate... button fails, because of the missing index.html. Then if I create a dummy index.html file, validation works, but I still cannot see the Javadoc when hovering a vendor class/method.
So my basic question is: How can I get this skewed Javadoc to display in Eclipse? Sub-questions I see at this point are:
Was it a bad idea to create a dummy index.html file? If yes, what should I do? (i.e. what tags/meta-information does Eclipse expect?)
A quick comparison of a standard Javadoc file (String.html, see attachment) vs. one of those vendor Javadoc (DomainObject.html, see attachment) reveals that meta-information possibly used by Eclipse is absent from my javadoc. For example, my Javadoc includes none of the many <meta> tags present in the String.html Javadoc
→ Does somebody know the logic/heuristic used by Eclipse to fetch a method/class Javadoc? Maybe point me to the code? With this information I may be able to understand what's skewed in my Javadoc, and hopefully fix it.
Anything you see fit if you ever faced a similar problem
I'm currently using Eclipse Juno SR1 on Java 7, under Windows 7.
Of course, feel free to ask for information I forgot to include. Thanks for your help!]]>Ronan Jouchet2013-01-24T17:09:50-00:00Re: Need help to integrate a vendor's Javadoc to Eclipse
https://www.eclipse.org/forums/index.php/mv/msg/452024/1006194/#msg_1006194
> Hi. I'm working on some big Java enterpriseware (MatrixOne / ENOVIA V6, if you mind). The maintainers provide some kind of Javadoc, and I am able to read it as HTML in my browser.
>
> However, I'm currently not able to integrate it to Eclipse, which is painful, because instead of just reading the Eclipse doc popups, I have to make round-trips to my browser. Here is what it looks like in Eclipse:
>
>
> After learning that the Javadoc can be defined at project and .jar level, I tried to do that, knowing that:
>
> the javadoc folder contains a packages-list file (see attachment), which seems to sanely define the documented packages
> the javadoc folder contains the typical folder/subfolder package structure, itself containing ClassName.html files. E.g. the com.matrixone.apps.domain line of my packages-list file is matched by a com/matrixone/apps/domain, containing lots of ClassName.html files
> the javadoc folder doesn't contain a index.html file
This should work assuming that
- the Javadoc location points to the root where the package structure
(e.g. 'com') starts
- the file names in the leaf folders follow this pattern <typeName>.html
Dani
>
>
> When I try to define my Javadoc, the Validate... button fails, because of the missing index.html. Then if I create a dummy index.html file, validation works, but I still cannot see the Javadoc when hovering a vendor class/method.
>
> So my basic question is: How can I get this skewed Javadoc to display in Eclipse? Sub-questions I see at this point are:
>
> Was it a bad idea to create a dummy index.html file? If yes, what should I do? (i.e. what tags/meta-information does Eclipse expect?)
> A quick comparison of a standard Javadoc file (String.html, see attachment) vs. one of those vendor Javadoc (DomainObject.html, see attachment) reveals that meta-information possibly used by Eclipse is absent from my javadoc. For example, my Javadoc includes none of the many <meta> tags present in the String.html Javadoc
> → Does somebody know the logic/heuristic used by Eclipse to fetch a method/class Javadoc? Maybe point me to the code? With this information I may be able to understand what's skewed in my Javadoc, and hopefully fix it.
> Anything you see fit if you ever faced a similar problem :)
>
>
> I'm currently using Eclipse Juno SR1 on Java 7, under Windows 7.
>
> Of course, feel free to ask for information I forgot to include. Thanks for your help!]]>Dani Megert2013-01-30T12:11:16-00:00Re: Need help to integrate a vendor's Javadoc to Eclipse
https://www.eclipse.org/forums/index.php/mv/msg/452024/1006226/#msg_1006226
Yes, both constraints are respected:
the Javadoc location points to the root where the package structure (e.g. 'com') starts
the file names in the leaf folders follow this pattern <typeName>.html
I'm attaching a listing of the Javadoc root, generated with dirhtml.]]>Ronan Jouchet2013-01-30T13:58:56-00:00Re: Need help to integrate a vendor's Javadoc to Eclipse
https://www.eclipse.org/forums/index.php/mv/msg/452024/1006479/#msg_1006479
> Hi Dani,
>
> Yes, both constraints are respected:
>
> the Javadoc location points to the root where the package structure (e.g. 'com') starts
> the file names in the leaf folders follow this pattern <typeName>.html
>
> I'm attaching a listing of the Javadoc root, generated with dirhtml.
I can't tell why it's not working. You would have to create an example
and file a bug against JDT UI.