| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html lang="en"> |
| <head> |
| <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <meta http-equiv="Content-Style-Type" content="text/css"> |
| <title> |
| Javadoc Location Dialog |
| </title> |
| <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css"> |
| </head> |
| <body> |
| <h1> |
| Javadoc Location Dialog |
| </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, class folders or Java projects. For projects it documents the elements of all source folders, |
| for JARs and class folders, elements contained in the JAR are documented. The location is used by |
| </p> |
| <ul> |
| <li> |
| <strong>Open Attached Javadoc</strong> in the <a href="ref-menu-navigate.htm">Navigate menu</a> to open the attached Javadoc 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://download.oracle.com/javase/6/docs/api/ |
| </blockquote> |
| |
| <table border="1" cellspacing="0" cellpadding="5" width="100%" summary="Javadoc location settings"> |
| <tr> |
| <th> |
| <p> |
| Option |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| <th> |
| <p> |
| Default |
| </p> |
| </th> |
| </tr> |
| <tr> |
| <td valign="top"> |
| <p> |
| Javadoc URL |
| </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> |
| Validate |
| </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> |
| Javadoc for JARs and class folders can also be located inside an archive available on the local file system. In that case the location of the archive as well as the location |
| of the doc inside the archive has to be specified. |
| </p> |
| |
| <table border="1" cellspacing="0" cellpadding="5" width="100%" summary="Javadoc location settings"> |
| <tr> |
| <th> |
| <p> |
| Option |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| <th> |
| <p> |
| Default |
| </p> |
| </th> |
| </tr> |
| <tr> |
| <td valign="top"> |
| <p> |
| Archive location |
| </p> |
| </td> |
| <td valign="top"> |
| <p> |
| Specify the location of the archive that contains the generated Javadoc documentation. You can <strong>Browse</strong> in the local file system for a Javadoc location |
| </p> |
| </td> |
| <td valign="top"> |
| <empty> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top"> |
| <p> |
| Path within archive |
| </p> |
| </td> |
| <td valign="top"> |
| <p> |
| Specify the path inside the archive that contains the generated Javadoc documentation. You can <strong>Browse</strong> to see the content of the archive. |
| </p> |
| </td> |
| <td valign="top"> |
| <empty> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top"> |
| <p> |
| Validate |
| </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> |
| |
| |
| |
| |
| </body> |
| </html> |
| |
