| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <meta http-equiv="Content-Style-Type" content="text/css"> |
| <meta name="GENERATOR" content="Mozilla/4.75 [en] (Windows NT 5.0; U) [Netscape]"> |
| <title> |
| Javadoc location page |
| </title> |
| <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css"> |
| </head> |
| <body> |
| <h1> |
| Javadoc location page |
| </h1> |
| <p> |
| This dialog lets you define the location of the Javadoc documentation for a JAR or a Java project. |
| </p> |
| <p> |
| You can reach this dialog the following ways: |
| </p> |
| <ul> |
| <li> |
| Select a JAR or Java project, open the context menu and select Properties > Javadoc Location or use <strong>Properties</strong> from the <a href= |
| "ref-menu-file.htm">File menu</a> |
| </li> |
| <li> |
| In the Javadoc generation wizard, on the Standard doclet settings page, choose <strong>Configure</strong> |
| </li> |
| </ul> |
| <p> |
| Javadoc can be attached to JARs or Java projects. For projects it documents the elements of all source folders, |
| for JARs, elements contained in the JAR are documented. The location is used by |
| </p> |
| <ul> |
| <li> |
| <strong>Open External Javadoc</strong> in the <a href="ref-menu-navigate.htm">Navigate menu</a> to find the Javadoc location of an element |
| </li> |
| <li> |
| Context Help (F1) to point to a Javadoc location |
| </li> |
| <li> |
| <a href="ref-export-javadoc.htm">Javadoc Export Wizard</a> to link to other documentation or as default destination for a project's documentation |
| </li> |
| </ul> |
| <p> |
| Valid locations are URLs that point to a folder containing the API documentation's <em>index.html</em> and <em>package-list</em> file. Examples are: |
| </p> |
| <blockquote> |
| file:///M:/JAVA/JDK1.2/DOCS/API/<br> |
| http://java.sun.com/j2se/1.4/docs/api/ |
| </blockquote> |
| <table border="1" cellspacing="0" cellpadding="5" width="100%"> |
| <tr> |
| <th> |
| <p> |
| Option |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| <th> |
| <p> |
| Default |
| </p> |
| </th> |
| </tr> |
| <tr> |
| <td valign="top"> |
| <p> |
| <strong>Javadoc Location</strong> |
| </p> |
| </td> |
| <td valign="top"> |
| <p> |
| Specify the location of the generated Javadoc documentation. You can <strong>Browse</strong> in the local file system for a Javadoc location (will result in a |
| file:// URL) |
| </p> |
| </td> |
| <td valign="top"> |
| <empty> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top"> |
| <p> |
| <strong>Validate</strong> |
| </p> |
| </td> |
| <td valign="top"> |
| <p> |
| Validate the current location by trying to access the <em>index.html</em> and <em>package-list</em> file with the given URL. If the validation was |
| successful, you can directly open the documentation. |
| </p> |
| </td> |
| <td valign="top"> |
| <p> |
| |
| </p> |
| </td> |
| </tr> |
| </table> |
| <p> |
| <img src="../images/ngrelt.gif" alt="Related tasks" border="0" height="27" width="159"><br> |
| <a href="../tasks/tasks-196.htm">Creating Javadoc documentation</a> <br> |
| <a href="../tasks/tasks-197.htm">Specifying the location of the Javadoc command</a> <br> |
| <a href="../tasks/tasks-71.htm">Viewing Javadoc information</a><br><br> |
| <a href="../reference/ref-export-javadoc.htm">Export Javadoc wizard</a> <a href="../reference/ref-preferences-javadoc.htm">Javadoc preferences</a> |
| <p> |
| <a href="../hglegal2003.htm"><img src="../images/ngibmcpy2003.gif" alt="Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved." border="0" width="324" height="14"></a> |
| </p> |
| </body> |
| </html> |
| |
