Note that there are some explanatory texts on larger screens.

plurals
  1. PONeed help to integrate a particular vendor's Javadoc to Eclipse
    primarykey
    data
    text
    <p>I'm working on big Java enterpriseware (<a href="http://www.3ds.com/products/enovia/products/enovia-v6/" rel="nofollow noreferrer">MatrixOne / ENOVIA V6</a>, if you mind). The maintainers provide some kind of Javadoc, which looks like very vanilla Javadoc, and I can read it as HTML in my browser.</p> <p>However, I'm unable to integrate it to Eclipse, which is painful because I have to make round-trips to my browser. In Eclipse, I just get the dreaded <code>Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found.</code>: <img src="https://i.stack.imgur.com/f8Nd8.png" alt="enter image description here"></p> <p>After <a href="https://superuser.com/questions/167458/how-to-add-javadocs-to-eclipse">learning</a> that Javadoc can be defined at project and <code>.jar</code> level, I tried to do both, knowing that:</p> <ol> <li>the javadoc folder contains <a href="https://dl.dropbox.com/u/13140569/enovia-javadoc-missing-eclipse/package-list" rel="nofollow noreferrer">a <code>package-list</code> file</a>, which seems to sanely define the documented packages</li> <li>the javadoc folder contains the typical folder/subfolder package structure, itself containing <code>ClassName.html</code> files. E.g. the <code>com.matrixone.apps.domain</code> line of my <code>package-list</code> file is matched by a <code>com/matrixone/apps/domain</code> structure, containing lots of <code>ClassName.html</code> files</li> <li>the javadoc folder doesn't contain a <code>index.html</code> file</li> </ol> <p>When I try to define my Javadoc, the <code>Validate...</code> button fails because of a missing <code>index.html</code>. Then if I create a dummy <code>index.html</code> file, validation works, but I still cannot see the Javadoc when hovering a vendor class/method.</p> <p>So my question is: <em>What's missing to get this skewed Javadoc to display in Eclipse?</em> Sub-questions I see at this point are:</p> <ol> <li>Was it a bad idea to create a dummy <code>index.html</code> file? If yes, what should I do? (i.e. what tags/meta-information does Eclipse expect?)</li> <li>A quick comparison of a standard Javadoc file (<a href="https://dl.dropbox.com/u/13140569/enovia-javadoc-missing-eclipse/String.html" rel="nofollow noreferrer"><code>String.html</code></a>) vs. one of those vendor Javadoc (<a href="https://dl.dropbox.com/u/13140569/enovia-javadoc-missing-eclipse/DomainObject.html" rel="nofollow noreferrer"><code>DomainObject.html</code></a>) reveals that meta-information possibly used by Eclipse is absent from my javadoc. For example, my vendor Javadoc includes none of the many <code>&lt;meta&gt;</code> tags present in the <code>String.html</code> Javadoc <code>&lt;head&gt;</code>.<br> → <strong>Does somebody know the logic/heuristic</strong> used by Eclipse to fetch a method/class Javadoc? <strong>Maybe point me to the code?</strong> With this information I may be able to figure out what's wrong in my Javadoc, and hopefully fix it.</li> <li>Anything you see fit if you ever faced a similar problem.</li> </ol> <p>I'm currently using Eclipse Juno SR1 on Java 7, under Windows 7.</p> <p>Of course, feel free to comment to ask for information I forgot to include. Thanks for your help!</p>
    singulars
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload