| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. 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"> |
| <meta name="GENERATOR" content="Mozilla/4.76 [en] (Windows NT 5.0; U) [Netscape]"> |
| <title> |
| Viewing Javadoc information |
| </title> |
| <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css"> |
| <script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"> </script> |
| </head> |
| <body> |
| <h1> |
| Viewing Javadoc information |
| </h1> |
| <p> |
| The JDT provides easy access to Javadoc information for the code edited in the Java editor. |
| </p> |
| <ol> |
| <li> |
| Open the Java editor on a Java file. |
| </li> |
| <li> |
| Place the mouse pointer over the element whose Javadoc information you want to view (a method name, for example). |
| </li> |
| <li> |
| If Javadoc information is available, a pop-up window opens, displaying the Javadoc information. HTML Javadoc can be viewed as any other resource in the workbench, through |
| an embedded or external editor or viewer. Import the Javadoc into the workbench and double-click it in the Package Explorer. |
| </li> |
| </ol> |
| <p> |
| You can also view Javadoc information by: |
| </p> |
| <ol> |
| <li> |
| Opening the Java editor on a Java file. |
| </li> |
| <li> |
| Placing the mouse pointer over the element whose Javadoc information you want to view (a method name, for example). |
| </li> |
| <li> |
| Pressing <kbd>F2</kbd> or selecting <strong>Edit > Show Tooltip Description</strong> from the menu bar. |
| </li> |
| </ol> |
| <p> |
| To view Javadoc in the Javadoc view: |
| </p> |
| <ol> |
| <li> |
| Open the Java editor on a Java file. |
| </li> |
| <li> |
| Place the caret over the element whose Javadoc information you want to view (a method name, for example). |
| </li> |
| <li> |
| Open the Javadoc View (press <kbd>Alt+Shift+Q, J</kbd> or select |
| <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=org.eclipse.jdt.ui.JavadocView)")'> |
| <img src="PLUGINS_ROOT/org.eclipse.help/command_link.png"> |
| <strong>Window > Show View > Javadoc</strong></a>). |
| </li> |
| </ol> |
| <p> |
| To view Javadoc in an external browser: |
| </p> |
| <ol> |
| <li> |
| Open the Java editor on a Java file. |
| </li> |
| <li> |
| Place the caret over the element whose Javadoc information you want to view (a method name, for example). |
| </li> |
| <li> |
| Press <kbd>Shift+F2</kbd> or select <strong>Navigate > Open External Javadoc</strong> from the menu bar. |
| </li> |
| </ol> |
| |
| <p> |
| <img src="../images/ngrelc.png" alt="Related concepts" border="0" > |
| </p> |
| <p> |
| <a href="../concepts/concepts-7.htm">Java editor</a> |
| </p> |
| <p> |
| <img src="../images/ngrelt.png" alt="Related tasks" border="0" > |
| </p> |
| <p> |
| <a href="tasks-54.htm">Using the Java editor</a><br> |
| <a href="tasks-65.htm">Using content/code assist</a><br> |
| <a href="tasks-69.htm">Viewing documentation and information</a><br> |
| <a href="tasks-70.htm">Viewing marker help</a> |
| </p> |
| <p> |
| <img src="../images/ngrelr.png" alt="Related reference" border="0" > |
| </p> |
| <p> |
| <a href="../reference/ref-view-package-explorer.htm">Package Explorer</a><br> |
| <a href="../reference/ref-dialog-javadoc-location.htm">Javadoc Location</a> |
| </p> |
| |
| </body> |
| </html> |
| |
