Home » Language IDEs » Java Development Tools (JDT) » Need help to integrate a vendor's Javadoc to Eclipse
 Need help to integrate a vendor's Javadoc to Eclipse [message #1005223] |
Thu, 24 January 2013 17:09  |
|
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
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!
|
|
|
| Re: Need help to integrate a vendor's Javadoc to Eclipse [message #1006194 is a reply to message #1005223] |
Wed, 30 January 2013 12:11  |
 Dani Megert
Messages: 3802
Registered: July 2009 |
Senior Member |
|
|
On 24.01.2013 19:22, Ronan Jouchet wrote:
> 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!
|
|
| | |
Goto Forum:
Current Time: Sat Apr 20 02:26:49 GMT 2024
Powered by FUDForum. Page generated in 0.03101 seconds |
] 
Search
Help
Register
Login
Home
