JDocEditor Faq

  1. Installed the JDocEditor files in the correct Eclispe directory, but plugin is no where to be found when Eclipse is running.

    — Restart Eclipse with the "-clean" command line parameter.

  2. Special considerations for running JDocEditor on MacOS.

    — Make sure you have Eclipse 3.2RC3+ and the lastest JDK 1.5 for MacOS installed and that the Eclipse platform itself is using that JDK. JDocEditor uses the SWT_AWT bridge, which has been known to present problems for MacOS in the past. See, Bugzilla Bug 67384 and Apple SWT Compatibility

  3. The JDocEditor panes are blank.

    — For versions less than 3, the Outline View must be open in the current perspective for JDocEditor to track focus in the active JDT editor. While the Outline View must be open, it need not be showing. Just minimize or tuck the view behind some other view. OTOH, Outline is quite helpful view to use whenever editing.

  4. The Outline View is open, but JDocEditor does not show the right JavaDoc for editing.

    — For versions less than 3, make sure the Outline View is linked with the active JDT editor.

  5. JDocEditor permits editing, but the JavaDoc in the JDT just is not being formatted right. It is a mess, or the HTML is not being formatted to be easily readable.

    — Make sure Eclipse comment formatter is enabled and set to format HTML tags.

  6. Cannot edit the JavaDoc for Fields or some Methods.

    — For versions less than 3, the Outline View must be set to show those member types. Otherwise Eclipse won't generate the necessary selection events for JDocEditor to track the Field or Member selected.

  7. When switching between different JDT editors, JDocEditor does not seem to track the change.

    — Eclipse typically fails to generate any event usable by JDocEditor when switching between JDT editors. Whenever this happens, just click in the JDT Editor or on a desired Java element in the Outline View.

  8. CSS markup does not seem to work.

    — CSS support is generally limited to CSS1. With a suitable CSS style sheet, JDocEditor will display text in a style that will match your 'printed' JavaDoc.

  9. Tooltips on the JDocEditor toolbar do not show on hover.

    — JDocEditor has to have focus for the toolbar tooltips to respond to hover. Even then, they seem a bit slow to show.

  10. There are hyperlinks in the right pane.

    — Clicking a hyperlink should open the Eclipse help browser to the JavaDoc page for that element. JDocEditor can generally open a page in a package available on your local network or accessible over the Internet.

  11. The Eclipse help browser opens, but is blank or does not show the correct JavaDoc.

    — Need to go to the JavaDoc Location preference page in JDocEditor (Preferences -> JDocEditor -> JavaDoc Locations). Edit and, as needed, add entries for each JavaDoc package:

    1. Package Prefix: the base portion of the FQN of the JavaDoc stored in a particular container. When a link is clicked, JDocEditor determines the FQN of the Java element clicked on and does a best match against the list of package prefixs to find the relevant location entry.
    2. FQN Base path: for JavaDoc stored in a directory heirarchy, typically the absolute path to the "api" directory containing the JavaDoc. Can be either a local filesystem path or a URL path (JDocEditor will prepend "http://").
    3. Jar/Zip file: for JavaDoc stored in a jar or zip file, the absolute filesystem or URL path to the container.
    4. Container internal path: for JavaDoc stored in a jar/zip, need to specify any container internal offset path to the base directory of the JavaDoc.
  12. Where to specify the formatting style of JavaDoc comments.

    — Preferences ->Java->Code Style -> Code Formatter -> Edit -> Comments

  13. Where to define the initial content of generated JavaDoc comments.

    — Preferences -> Java -> Code Style -> Code Templates

  14. Where to select internal vs external help browser.

    — Preferences -> Help

  15. Where to specify which external browser to use.

    — Preferences -> General -> Web Browser

Sections