By: Josh Fletcher
Abstract: Adding dcumentation to JBuilder 3 - Windows Edition for 3rd party Libraries and user created classes.
For both options, the Doc viewer in JBuilder 3 - Windows Edition expects the documentation for the class to be in an HTML file the reflects the fully qualified package name of the class. For example, given a class called "com.a.b.c.class" and a Doc Root of "C:myprojectdoc" the documentation file would be "C:\myproject\doc\com.a.b.c.html".
Some docs are distributed such that the HTML file follows a directory structure rather than package name, i.e. "C:\DOC_ROOT\com\abc.html". The doc viewer in JBuilder will not view files following this structure (*unless* they are in the default location as JavaDoc Wizard generated docs, see 2 below).
To add the documentation:
If you want to specify another location besides the JavaDoc Wizard default, create a "dummy" library that points to your project and add the appropriate "Doc Path". Make sure that your HTML files follow the above guideline.
To view the documentation:
For classes not in your project - Place the cursor on the class that you want to view the documentation for in the Source pane. Right-click and select "Browse symbol at cursor" -or- press CTRL-ENTER. When you see the source for the class (either reverse-compiled or "real"), select the "Doc" tab.
For your classes - Choose the class that you want to see the documentation for in the Navigation pane. Select the "Doc" tab.
Server Response from: ETNASC04