Skip to main content
1-Visitor
January 12, 2010
Question

AOM & DOM javadoc in Eclipse?

  • January 12, 2010
  • 2 replies
  • 1088 views
I've been trying to integrate javadoc for the AOM and DOM classes into
my Eclipse (Galileo - Version: 3.5.1.R35x_... Eclipse IDE for Java
Developers 1.2.1.20090918-0703) without success.

When I select the properties for the referenced jars, aom.jar and
w3cdom.jar, and try to point to the paths, e.g. C:\Program
Files\Arbortext\Editor\docs\javadoc\aom, Eclipse complains:

[warning icon] Location might be invalid. Files 'package-list' and
'index.html' that are typically available at the root of documentation
created by the Javadoc tool have not been found.

Though there is an index.html under C:\Program
Files\Arbortext\Editor\docs\javadoc\aom, there is not a "package-list".
I have also tried the URL:

    2 replies

    1-Visitor
    January 12, 2010
    John,

    You can find some more details at:

    1-Visitor
    January 12, 2010
    Thank you, Brandon.

    I displayed
    file:///C:/Program%20Files/Arbortext/Editor/docs/javadoc/aom/index.html
    in my browser, selected and copied the listing under "Packages" in the
    top left frame which resulted in (indentation added for this email
    listing) the following text placed in my clipboard:

    com.arbortext.epic
    com.arbortext.epic.cms
    com.arbortext.epic.io
    com.arbortext.epic.table
    com.arbortext.epic.ui
    org.w3c.dom
    org.w3c.dom.events
    org.w3c.dom.ranges
    org.w3c.dom.validation
    org.w3c.dom.views

    which I then saved to "C:/Program
    Files/Arbortext/Editor/docs/javadoc/aom/package-list". Then, selecting
    the aom.jar in Eclipse, I assigned the directory "C:/Program
    Files/Arbortext/Editor/docs/javadoc/aom" and tried the Validate button.
    The dialog window with the following appeared: "Location is likely
    valid. Files 'package-list' and index.html' have been found.". The
    Arbortext classes within Eclipse now have attendant javadoc.
    Unfortunately, the org.w3c.dom ones do not... probably because of the
    structure of the shipped javadoc being a child in the AOM tree.

    At any rate your help got me to a good level and provided me insight to
    this problem. Others can follow using the method I described about, or
    simply copy the indented packages above (remove the indentation) and
    save to their [EPIC_HOME]/docs/javadoc/aom directory.

    Again, thank you.