javadoc.1 revision 12442:aa8e52dfeee9
t
Copyright (c) 1994, 2014, Oracle and/or its affiliates. All rights reserved.
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

This code is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 only, as
published by the Free Software Foundation.

This code is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
version 2 for more details (a copy is included in the LICENSE file that
accompanied this code).

You should have received a copy of the GNU General Public License version
2 along with this work; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
or visit www.oracle.com if you need additional information or have any
questions.

Title: javadoc
Language: Japanese
Date: 2015��3��3��
SectDesc: ����������
Software: JDK 8
Arch: ����
Part Number: E58103-01
Doc ID: JSSON

"javadoc" "1" "2015��3��3��" "JDK 8" "����������"
-----------------------------------------------------------------
* Define some portability stuff
-----------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
http://bugs.debian.org/507673
http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------------------------------------------
* set default formatting
-----------------------------------------------------------------
disable hyphenation
disable justification (adjust text to left margin only)
-----------------------------------------------------------------
* MAIN CONTENT STARTS HERE *
-----------------------------------------------------------------
"����"
javadoc - Java����������������������API��������������HTML��������������������
"����"

.\}

javadoc {packages|source-files} [options] [@argfiles]
.\}

packages

java.lang java.lang.reflect java.awt��������������������������������������������������������������������������������������������������-subpackages�������������������������������������������� ����������������javadoc������������������������������������������������������������������������������-sourcepath������������������������������������������������������������������������

source-files

Class.java Object.java Button.java������������������������������������������Java����������������������������������������javadoc������������������������������������������������������������/home/src/java/awt/Graphics*.java��������������������������������������������������������������������������������������������������������������������������������

options

��������������������������������������������������������������������

@argfiles

javadoc����������������������������������������������������������������������������������������������������

"����"

javadoc������������������Java����������������������������������������������������������������������������������������public��������protected��������������������������(����������������������)����������������������������������������������������������������������������������HTML��������������������javadoc������������API������������������������������������������������������������������������������������

javadoc����������������������������������������������������������������������������������������������������������������������������������-subpackages����������������������������������������������������������������������������������������������������������������������������������������������������������������������Java������������������������������������������������������������������

"����������������������"

javadoc��������������������������������������������������������������������������������������������������������������������������������������javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������javadoc����������3��������������������������������������������-subpackages��������������������������������������������������������������������������������������������������������javadoc������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������(.java������)������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������������������������������������

������������

����������������javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������@����������������������javadoc������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����(������������������������������������)��

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} @see������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} {@link}����������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} @throws������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������������������������������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������

��������������������������������������������������������(��������������������)������������������������������-link������-linkoffline��������������������������

����������

javadoc������������������������1������������������������������������������������������������������������������������������������������������javadoc��������������������������������������������

javadoc������������������Java��������������������Java����������������������������javadoc����������javac����������������������������������������������������������������������������javadoc����������������������������������������������������������������������������������HTML����������������������Jjavadoc��������������������������������������������������������������������������������������������������������������������������������������������������������������

javadoc����������������������������������������������������������������������������������������������������������������API��������������������������������������������������������������������javadoc������������������������

����������������������������������HTML����������������������������������������������������������������������������������������������������������������������������������������������javadoc������������������������������������������������������������������������������������������������������������������������������������

������������javadoc��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������javadoc����������������������������������������������������������������������

javadoc������������������������������������������������������������������������������������������ javadoc�������������������������������������������������������������������������������������������������������������������������������������������������� (http://docs.oracle.com/javase/8/docs/technotes/tools/findingclasses.html)������������������

������������������������������������������������javadoc����������������������������������������������������

"Javadoc��������������"

javadoc��������������������������������������������������������������������������javadoc������������������������������������������������������������������������������������������������������HTML������API����������������������������������������������������������������������������������HTML��XML��MIF��RTF��������������������������������������������������������������������������

-doclet����������������������������������������������������������javadoc������������������������������������������������������javadoc������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

"����������������"

javadoc��������������������������������������������������������������������������������������Java��������������������(.java)������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

"������������������������"

����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

"������������������������������"

������������������������������������������������������������������������������������������������������������������������������������javadoc��������������������������������������������������������������������������������������������������������������������������������������������������������

����������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} package-info.java��������������������������������������������������������������������������Javadoc������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} package.html������������������������������������Javadoc��������������������������������������������������������

����������������package.html��������������package-info.java��������������������1������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

package-info.java��������

package-info.java������������������������������������������������������������������������������������������������������������������

����: ������������������������/**������*/������������������������������������������������������������������������

.\}

/**
 * Provides the classes necessary to create an 
 * applet and the classes an applet uses 
 * to communicate with its applet context.
 * <p>
 * The applet framework involves two entities:
 * the applet and the applet context.
 * An applet is an embeddable window (see the
 * {@link java.awt.Panel} class) with a few extra
 * methods that the applet context can use to 
 * initialize, start, and stop the applet.
 *
 * @since 1.0
 * @see java.awt
 */
package java.lang.applet;
 
.\}

package.html��������

package.html��������������������������������������������������������������������������������<body>��������������������

��������: java/applet/package.html

.\}

<HTML>
<BODY>
Provides the classes necessary to create an applet and the 
classes an applet uses to communicate with its applet context.
<p>
The applet framework involves two entities: the applet
and the applet context. An applet is an embeddable
window (see the {@link java.awt.Panel} class) with a
few extra methods that the applet context can use to
initialize, start, and stop the applet. 
 
@since 1.0 
@see java.awt
</BODY>
</HTML>
 
.\}

package.html����������������HTML��������������������������������������������������������������������������������������HTML����������������������1����������������������������������������������������������������������������/**��*/��������������������������������������������������������������������������������������������������������������<body>����������������������������������������������������������������������������������������������������������������������������������������������������������������������������@see��������������������������������������������������������������������������������������������

������������������������

javadoc����������������������������������������������������������������������������������������������������������������������javadoc��������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������������������������package.html��������javadoc������������<body>��</body> HTML������������������������������������������<title>��������������������������������������������������������<head>������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������������������������������������������������������������Java������������������Standard Edition API���������� (http://docs.oracle.com/javase/8/docs/api/overview-summary.html)������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������������������������������������������������������������������������������������javadoc��������������������������������������������������������������������������������������������������������Java������������������Standard Edition API���������� (http://docs.oracle.com/javase/8/docs/api/overview-summary.html)������������������ ������������������������������������������������������������������������������������������
"����������������������"

����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������������

����������������overview.html��������������������������������������������������������������������������������������������������������

����������java.applet������������������������������/home/user/src/java/applet����������������������������������������������������������/home/user/src/overview.html����������������

��������������������������������javadoc������������������������������������1��������������������������������������������������������������������������������������������������������������-private����������javadoc����������1������������������������������������������������������������������������������������������������������������������������������1����������������������������������������������������������������

��������������������������������HTML������������1��������������������������������������������������������������������������������������������������������������������<body>����������������������������������������������������������������������{@link}��������������������������������������������������������������������������������@see������������������������������������������������������������

javadoc��������������������-overview����������������������������������������������������������������������������������������������������������������������������������javadoc��������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} <body>��</body>����������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������������������������������������������Java����������������Standard Edition API���������� (http://docs.oracle.com/javase/8/docs/api/overview-summary.html)������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������������������������������������������������������������
"����������������"

����������������������javadoc������������������������������������������������������������������������������������������������������������������������������������������������������Java��������������������������������������Java����������������������������������������������������������������������������������������HTML������������������������

������������������������������doc-files������������������������������������������doc-files������������������������������������������������������������������������������������������������������������doc-files������������������������������������1����������������

����������������������������java.awt.Button��������������������������������������������������������������/home/user/src/java/awt/doc-files/������������������������doc-files��������������/home/user/src/java/doc-files����������������������java������������������������������������������������������������������������

javadoc��������������������������������������������������������������������������������������������������������������javadoc��������������������������������������������������������������������������Button.java��������������������������������������������������������������������������

.\}

/**
 * This button looks like this: 
 * <img src="doc-files/Button.gif">
 */
 
.\}
"����������������������������������"

����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������javadoc��������������������������������������������������������������

��������������������������������������������������������������������������������������������������������������������������������������������������������������.java����������������������

����������������

��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������javadoc��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������com.package1����������������������������������������������������������������������������������������������������������������������������

.\}

com/package1/test-files/
 
.\}

����������������������������������������������������������������javadoc������������������������������������������������������������������������(com/package1/test-files/*.java����)����������������������������������������������������������������������

����������������������

����������������������������������������������������������javadoc����������������������������������������������������������Buffer-Template.java����������������������������������������������������javadoc��������������������.java������������������������������������������������������������������������������

"������������������"

����������������javadoc������������HTML��������������������������������������������������������������������������������������������������������������������������������������������������������������HTML������������������������������������javadoc������������2����������������������������������������������������������������������������������������������������������2����������������������������������������������������������������������������������(package-summary.html����)��

"��������������"

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������������������������������1��������������������������������������(classname.html)��

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������������������1����������������������(package-summary.html)��javadoc������������������������������������������������������������package.html������package-info.java������������������������HTML������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������������������1��������������(overview-summary.html)��������������������������������������������������������javadoc������������-overview����������������������������������HTML����������������������������������������������������������javadoc��������������������������������������������������HTML��������������������������������������������
"��������������"

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������������������1��������������������(overview-tree.html)��������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������1��������������������(package-tree.html)����������������������������������������������������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������1��������������(package-use.html)������������������������������������1������������������(class-use/classname.html)��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������A����������������������������������A��������������A����������������������������A����������������A����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������API������������������������������������API������(deprecated-list.html)��������API��������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������������������������������������(constant-values.html)��

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������(serialized-form.html)��������������������������������������������������������������������������������������������������������������������������API������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������Serializable������������������������(public��������public)��������readObject��writeObject����������������������������������������@serial��@serialField��@serialData����������������������������������������������������������������������������public��������������������������������(��������������������)��@serial exclude����������������������������package-private������������������������������(��������������������)��@serial include������������������������1.4������-private����������������������javadoc������������������������������public������������private����������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������(index-*.html)��������������������������������������������������������������������������������������������������������������������������������������Unicode����������������������������������1������������������������������������������(����������A\(enZ)��������������������������������������������������
"����������������"

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������(help-doc.html)��������������������������������������������������������������������������������������������������������������������������������������������������������������-helpfile��������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������HTML������������������1����index.html����������������������������������������������������������������������������index.html������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������������(*-frame.html)����������������������������������������������������������������������������������������HTML����������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������������(package-list)��-link������-linkoffline����������������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������������(stylesheet.css)����������������������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} doc-files��������������������������������������������������������������������������������������������������������������������������������������javadoc��������������������������������������������������������������������������������������������������������

������������������������������

"HTML��������"

javadoc��������������������������������������������������������(2������3)������������������������javadoc��������������������1����������������������1������������������������������������������������������������������������������������������������������javadoc��������������������1������������������������������������������������������������������������������������javadoc��������������������������������������������3����������������������(overview-summary.html)������������������������������������������������������������������������������overview-summary.html��������������������������������������

"������������������������"

������������������������������������������������������������Java����������������������������������������������������������������������������1������������������������1����������������������������������������

����������java.applet.Applet������������������������������������java/applet/Applet.html����������������

��������������������������apidocs������������java.applet������������������������������������������������������������frame����������������������������������������������������������������������������������������HTML������������������������������������������������

������������������������������������(*)����javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������doc-files������������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} apidocs: ��������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} index.html: HTML����������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} *overview-summary.html: ����������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} overview-tree.html: ������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} deprecated-list.html: ��������������������������API

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} constant-values.html: ������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} serialized-form.html: ����������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} *overview-frame.html: ������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} allclasses-frame.html: ��������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} help-doc.html: Javadoc��������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} index-all.html: -splitindex������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} index-files: -splitindex������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} index-<number>.html: -splitindex������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} package-list: ������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} stylesheet.css: ����������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} java: ������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} applet: ����������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} Applet.html: Applet��������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} AppletContext.html: AppletContext��������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} AppletStub.html: AppletStub��������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} AudioClip.html: AudioClip��������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} package-summary.html: ����������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} package-frame.html: ������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} package-tree.html: ��������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} package-use.html: ������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} doc-files: ����������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} class-use: �������������������������������������� - Applet.html: Applet������������ - AppletContext.html: AppletContext�������������������� - AppletStub.html: AppletStub�������������������� - AudioClip.html: AudioClip��������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} src-html: ����������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} java: ������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} applet: ���������������������������� - Applet.html: Applet�������������� - AppletContext.html: AppletContext�������������� - AppletStub.html: AppletStub�������������� - AudioClip.html: AudioClip��������������
"����������API����"

javadoc������������������������������������������������������������������������������������������������������������API��������������������������������Boolean������������������������������������

.\}

public final class Boolean
extends Object
implements Serializable
 
.\}

Boolean.valueOf��������������������������������

.\}

public static Boolean valueOf(String s)
 
.\}

javadoc������������������public��protected��private��abstract��final��static��transient��������volatile��������������������������synchronized������native��������������synchronized������native������������������������������������������API����������������������

API����������������������������������������������synchronized������������������������������������������������������������������������������������������1����enumeration����������������������������������������������������������������������������������������������������������������������������������������������������������������Hashtable��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

"������������������������������"

��������������������������������������������������������������������������������

"������������������������"

��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������/**����������������*/��������������������������������������������������������������������������������������������������������������������������������������������������

.\}

/**
 * This is the typical format of a simple documentation comment
 * that spans two lines.
 */
 
.\}

����������������������������������1��������������

.\}

/** This comment takes up only one line. */
 
.\}

��������������

����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������javadoc������������������������1��������������������������������������������������������������������������������������������

����������������������������������������������������import��������������������������javadoc������������������������������������������import������������������������������������

.\}

/**
 * This is the class comment for the class Whatever.
 */
 
import com.example; // MISTAKE - Important not to put import statement here
 
public class Whatever{ }
 
.\}

����������������

��������������������������������������������������������������������������������������������������������������/**����������������������������������������������������������������������@��������������������������������������������������(����������������������������������������������/**������)������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������1������������������������������������������������@see��������������������������������������

.\}

/**
 * This sentence holds the main description for this documentation comment.
 * @see java.lang.Object
 */
 
.\}

������������������������������

��������javadoc����������������������������������������������������������������������������������2����������������������1����@tag������������������������������������(��������������������������������)������1����{@tag}������������������������������������������������������������������������������������������������������������������������������������(/**)������������������������������������������������@������������������������������������������������������������������������������������������@����������������������������������������������������������������HTML������������&#064;����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������(����������������������������������)������������������������������������������������������������������������������������������������������������������������������������������������������������������������@deprecated������������������{@link}������������������javadoc������������������������

.\}

/**
 * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)}
 */
 
.\}

HTML������������������

����������HTML��������������HTML��������������HTML����������������������������������������������������������������HTML��������������������������������������������������������������������������������������������������������������������������������������������������HTML 3.2����������������������������������������������������������������������������HTML 4.0����������������

������������������������(<)��������������������(>)������������������&lt;������&gt;����������������������������������������������(&)��&amp;��������������������������������������������HTML����<b>������������������

.\}

/**
 * This is a <b>doc</b> comment.
 * @see java.lang.Object
 */
 
.\}

������������������

javadoc������������������������������������������������������������������������������������(*)��������������������������������������(*)������������������������������������������������������������������������������������������������������������������������<PRE>����������������������������������������������������������������������������������������������������������������������������������������������������������������������������(����������/**������<PRE>������������)����������������������

��������

��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������javadoc����������������HTML������������������������������������������������������������

��������������������

Java����������������������1������������������������������������������������������������1������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������1������������������������������������������������������2������������������������������

.\}

/** 
 * The horizontal and vertical distances of point (x,y)
 */
public int x, y; // Avoid this 
 
.\}

javadoc��������������������������������������������������������������

.\}

public int x
 
.\}

The horizontal and vertical distances of point (x, y).

.\}

public int y
 
.\}

The horizontal and vertical distances of point (x, y).

��������������������

������������������������������������������������������������������<H1>������<H2>������HTML������������������������������������������javadoc������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

"������������������������"

javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

����: ������������������������������������������������������������������������������������������-sourcepath����������������������������������������������������������������������������������������������������������������������������������1.3.n������������������������������������������������������������������������������������������

������������������

��������������@return��@param��@throws����������������������������������������������javadoc������������������������������������������������������������������������������������������������(��������)��������������������������������������������������������������

������������������@param������������������������������������������������������������������������������������������������������������@throws��������������������������������������������������������������@throws����������������������

������������������1.3����������������������������������������������������������������������������������������������������������������������

javadoc����������������������������������������

������������

{@inheritDoc}����������������������������������������@return��@param��@throws������������������������������������������������������������������������������������������������������

"��������������������������������"

����������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������������������������������������������������

������2����������������javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

3������������(������������������������������������������������������������������)������javadoc��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

"��������������������������������"

������������������������������������������������������{@inheritDoc}����������������javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

\h'-04' 1.\h'+01'\c .\}

" 1." 4.2
.\} ��������������������(����������������������)����������������������������������implements(������extends)������������������������������1������������������������������������������������������������������������������������������������

\h'-04' 2.\h'+01'\c .\}

" 2." 4.2
.\} ����1����������������������������������������������������������������������������(����������������������)��������������������������������������������������������������������������(��������������������1����������������������������������������)��

\h'-04' 3.\h'+01'\c .\}

" 3." 4.2
.\} ����2����������������������������������������������������������������������Object��������������������������������������������������������������������������

\h'-04' 1.\h'+01'\c .\}

" 1." 4.2
.\} ����������������������������������������������������������������������������������������������������������������������

\h'-04' 2.\h'+01'\c .\}

" 2." 4.2
.\} ����3a����������������������������������������������������������������������������������������������������������������������������
"JAVADOC����"

javadoc������������Java������������������������������������������������������������������������javadoc��������������������������������API����������������������������������������������������������������(@)����������������������������������������������������������������������������������������������������������������������������������������������(������������������������������������������)������������������������������������������������������������������������������������������1����������������������������@see����������������������������������������������������������������������������������������������������������

��������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������: ����������������������������������������������������������������������������������@tag������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������: ������������������������������������������������������������������������������������������������������{@tag}����������������������������

��������������������������-tag tagname:Xaoptcmf:"taghead"������������������������������������������������������������

"����������"

@author name-text

JDK 1.0������ -author������������������������������������������������������������������������������������������������������������1������������������������������������������@author����������������������������1����@author������1����������������������������������������������������������������������������javadoc��������������������������������������(,)��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������1������������������������������Javadoc����������Doc��������������������@author���������� (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@author)��������������������

{@code text}

JDK 1.5������ <code>{@literal}</code>������������ ����������HTML������������������������������Javadoc����������������������text����������������������������������������������������������������������������������������������(<Object>)��������(3 < 4)������(<-)����������������������(<������>)��HTML������������(&lt;������&gt;)��������������������������������������������������������������������������{@code A<B>C}����A<B>C����������������������������HTML������������������������������<B>����������������������������������������������������������������������������������������������������������������{@literal}������������������

@deprecated deprecated-text

JDK 1.0������ ����API������������������������API����������������������������������������������javadoc������������deprecated-text�������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������� ����������������������������������API����������������������������������������������API������������������������������������javadoc����������������������������������������������������������������������������������������������������������������������������������API����������{@link}����(Javadoc 1.2����������)������������������������ @deprecated annotation����������������������������������������������API������������������������ (http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation.html)�������������������� Javadoc����������Doc��������������������@deprecated���������� (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@deprecated)��������������������

{@docRoot}

JDK 1.3������ ������������������������������������������(������)������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������ ����{@docRoot}����������������������������������������������������������������������������������������������(@return��@param������@deprecated��������)��������������������������������������������������������������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������header��footer������bottom����������������������javadoc -bottom \*(Aq<a href="{@docRoot}/copyright.html">Copyright</a>\*(Aq������������ {@docRoot}������makefile����������������������������������makefile������������������������{}����������������������������������������������������Inprise MAKE����������5.2��Windows��������������������{{@docRoot}}����������������������������������������������-bottom��������������������������������������������������(������������)����������������(href����������������������)��

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������������������

.\}

/**
 * See the <a href="{@docRoot}/copyright.html">Copyright</a>.
 */
 
.\} ������������������������������������������������������������������������������������������������������������������������: <a href="{@docRoot}/copyright.html">����java/lang/Object.java������<a href="../../copyright.html">����java/lang/ref/Reference.java������<a href="../../../copyright.html">����������������

@exception class-name description

JDK 1.0������ @throws����������������@throws class-name description��������������������

{@inheritDoc}

JDK 1.4������ ������������������������������������������������������������������������������������������������������������������������������������������(������)������������������������������������������������������������������������������������������������������������������������ ��������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������@return��@param��@throws��������������������������������������������������������������������������������������������
������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

{@link package.class#member label}

JDK 1.2������ ������������label����������������������������������������label������������������������������������������������������������������������������������������������������������@return��@param������@deprecated����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������Javadoc����������Doc��������������������@link���������� (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#{@link)�������������������� ����������@see����������������������������������package.class#member��label������������������������������������������������{@link}����������������������������������������������������������������������������������������������������������������������������������������������������������{@link}������������������������������������������������������������(})��������������������������HTML����������������&#125;�������������� 1��������������������{@link}������������������������������������������������������������������������������������������@deprecated��@return��@param�������������������������������������������������� ��������������������������getComponentAt(int,int)��������������������������

.\}

Use the {@link #getComponentAt(int, int) getComponentAt} method.
 
.\} ����������������������������������������HTML��������������(����������������������������������������������������������)��

.\}

Use the <a href="Component.html#getComponentAt(int, int)">getComponentAt</a> method.
 
.\} ��������������������Web����������������������

.\}

Use the getComponentAt method.
 
.\}

{@linkplain package.class#member label}

JDK 1.4������ {@link}����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������Refer to {@linkplain add() the overridden method}.������Refer to the overridden method������������������

{@literal text}

JDK 1.5������ ����������HTML������������������������������Javadoc����������������������text����������������������������������������������������������������������������(<Object>)��������(3 < 4)������(<-)����������������(<������>)��HTML������������(&lt;������&gt;)��������������������������������������������������������������������������{@literal A<B>C}����A<B>C��������������������������HTML����������������������������������<B>��������������������������(����������������������������)��������������������������������������������{@code}������������������

@param parameter-name description

JDK 1.0������ ��������������������������������������parameter-name����������������description����������������������������������������������������������������������������������description����������������������������������������������������������������������������������������������������������������������������������������������Javadoc����������Doc��������������������@param���������� (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@param)�������������������� parameter-name������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������ ������������������������:

.\}

/**
 * @param <E> Type of element stored in a list
 */
public interface List<E> extends Collection<E> {
}
 
.\} ��������������������������:

.\}

/**
 * @param string the string to be converted
 * @param type the type to convert the string to
 * @param <T> the type of the element
 * @param <V> the value of the element
 */
<T, V extends T> V convert(String string, Class<T> type) {
}
 
.\}

@return description

JDK 1.0������ ��������������������������������description������������������������������������������������������������������������������������������������������������������������������������������������������������������������������Javadoc����������Doc��������������������@return���������� (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@return)��������������������

@see reference

JDK 1.0������ ������������������������������reference������������������������������������������������������1������������������������������������������������@see��������������������������������������������������������������������������������@see����������3����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������{@link}�������������������� ����1��@see string������������string����������������������������������������������������������string��������������URL��������������������������������������javadoc��������������������������������������(")��������������������������������������������������������@see "The Java Programming Language"���������������������������� ��������: "The Java Programming Language" ����2��@see <a href="URL#value">label</a>������������URL#value������������������������������������������URL#value������������������URL����������URL������javadoc����������������������������������������������(<)������������������������������������������������������@see <a href="spec.html#section">Java Spec</a>��������������������������: ��������: Java Spec ����3��@see package.class#member label����������������������������������������������������������������������������������Java��������������������������������������������������������������������������������������������������������������������������������������������������������������-noqualifier�������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������� Java SE 1.2����������������������������<code> HTML������������������������������Java SE 1.2.2������������������������������������������������<code>��������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} package.class#member����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������(#)����������������������class����������������������������������������������������������������������������member������������������������������������������������������������(����������������������������������������������������)������������������������������������������������������������javadoc������������������������������������������������������������������������������������-link��������������������������������������������������������������������������������������2����@see������������������������������������������������������������������ ����: ������������������������������javadoc������������������������������������������������������������������������������������������������������������������������������������������java.awt package������������javadoc������������������������Object������java.lang����������������������������������������������-link������-linkoffline��������������������������������������������������������������������������������������javadoc����������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} label��������������������������������������������������������������������������������������������������label��������������package.class.member������������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������package.class#member��label����������������������������������������������������������������������������������������������������������������������������������������������
������������@see����(Character��������)����String��������equals����������������������������������������String#equals(Object)��������equals������������������������������

.\}

/**
 * @see String#equals(Object) equals
 */
 
.\} ������������������������������HTML��������������

.\}

<dl>
<dt><b>See Also:</b>
<dd><a href="../../java/lang/String#equals(java.lang.Object)"><code>equals<code></a>
</dl>
 
.\} ������������������������������������������������������������������������������������������ ��������: equals

����������

����package.class#member��������������java.lang.String#toUpperCase()��������������������������������String#toUpperCase()��#toUpperCase()������������������������������������������������������������������������javadoc������������������Java������������������������������������������@see��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������Class����������������������������������Type��������������������������������������������������������method����������������������������������������������������������

.\}

Typical forms for @see package.class#member 
Referencing a member of the current class
@see #field
@see #method(Type, Type,...)
@see #method(Type argname, Type argname,...)
@see #constructor(Type, Type,...)
@see #constructor(Type argname, Type argname,...) 
 
Referencing another class in the current or imported packages
@see Class#field
@see Class#method(Type, Type,...)
@see Class#method(Type argname, Type argname,...)
@see Class#constructor(Type, Type,...)
@see Class#constructor(Type argname, Type argname,...)
@see Class.NestedClass
@see Class 
 
Referencing an element in another package (fully qualified)
@see package.Class#field
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type argname, Type argname,...)
@see package.Class#constructor(Type, Type,...)
@see package.Class#constructor(Type argname, Type argname,...)
@see package.Class.NestedClass
@see package.Class
@see package
 
.\}

����������������������:

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������(������������������������)��������javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������(��������1\(en3)������������������������������������������������������������(��������4\(en5)����@see������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������������������������getValue����������������������������������������������������������������������������������javadoc������������������������������������������������������������������������������������������javadoc����������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������������������������������������������outer.inner������������������������������������inner����������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������������������������������������������������������(.)��������������������(#)������������������������������������javadoc��������������������������������������������������������������������������������������������������������������������������������������������������������javadoc������������������������������������������������������������������������������������

@see��������������

javadoc����������������������������������������������������������������������������@see������������������������2����������������������������������@see��������������������������������������������������������������������������������������������������������

������@see��������������������������

\h'-04' 1.\h'+01'\c .\}

" 1." 4.2
.\} ����������������������������������

\h'-04' 2.\h'+01'\c .\}

" 2." 4.2
.\} ��������������������������������������(��������������������)��

\h'-04' 3.\h'+01'\c .\}

" 3." 4.2
.\} ��������������������������������������(��������������������)��

\h'-04' 4.\h'+01'\c .\}

" 4." 4.2
.\} ������������������

\h'-04' 5.\h'+01'\c .\}

" 5." 4.2
.\} ������������������������������������������������������������(import��������������������)��

javadoc��������������������������������1-3����������������������������������������������������������������������������������������������������������������������������������E��������������E��������������������������������E������������������������������������4��5������javadoc����������1����������������������������������������������������������������������������(����������������������������������������������)������5������javadoc������������java.lang��������������������������������������������������������������������������������������

javadoc��������������������������������������������@see������������������Java������������������������������������������������(��������javadoc����������������������������������������������������������������������������������������������������������������������������������������)������������������Java����������������������������������javadoc����������������������������������������������������������������������������������������������������������������������������������������������������

\h'-04' 1.\h'+01'\c .\}

" 1." 4.2
.\} ����������������������������������

\h'-04' 2.\h'+01'\c .\}

" 2." 4.2
.\} ��������������������������������������(��������������������)��

\h'-04' 3.\h'+01'\c .\}

" 3." 4.2
.\} ��������������������������������������(��������������������)��

\h'-04' 4.\h'+01'\c .\}

" 4." 4.2
.\} ������������������

\h'-04' 5.\h'+01'\c .\}

" 5." 4.2
.\} ������������������������������������������������������������(import��������������������)��

javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������������@see������java.awt.event.KeyEvent������������������������java.awt package����������������������������������������������������������������javadoc����������������������������������������

��������������������

label��������������package.class.member������������������������������������������������������������������������������������������������������javadoc������������������������������������������������������������������������String.toUpperCase()��������������������������������������������������������������������������������������������������������������������������������������(����������������)��������������������������������������-noqualifier������������������������

������������: @see������������������������������������������������������

��: @see String#toLowerCase()

����: toLowerCase() - ������������������������������������

������������: @see������������������������������������������������������

��: @see Character#toLowerCase(char)

����: Character.toLowerCase(char) - ����������������������������������������

������������: @see����������������������������������������������������������

��: @see java.io.File#exists()

����: java.io.File.exists() - ����������������������������������

@see��������

������������������@see������java.applet.Applet����������������������������������������������������������������������������������������Javadoc����������Doc��������������������@see���������� (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@see)��������������������

.\}

 See also:
@see java.lang.String // String 
@see java.lang.String The String class // The String class 
@see String // String 
@see String#equals(Object) // String.equals(Object) 
@see String#equals // String.equals(java.lang.Object) 
@see java.lang.Object#wait(long) // java.lang.Object.wait(long) 
@see Character#MAX_RADIX // Character.MAX_RADIX 
@see <a href="spec.html">Java Spec</a> // Java Spec 
@see "The Java Programming Language" // "The Java Programming Language" 
 
.\}

����: @see������������������������������������������������������������-link������������������������

@serial field-description | include | exclude

JDK 1.2������ �������������������������������������������������������������������������������������������������������������������������������� (http://docs.oracle.com/javase/8/docs/platform/serialization/spec/serial-arch.html#5251)������������������ Oracle�������������������������������������������� (http://www.oracle.com/technetwork/java/javase/documentation/serialized-criteria-137781.html)������������������ field-description(��������)�������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������� ������������������������������������������������������������������������������������������������������������������������������������ include������exclude������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} Serializable��������������public������protected��������������������(����������������������������������)��@serial exclude����������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} Serializable��������������private������package-private��������������������(����������������������������������)��@serial include����������������������������������������������
����������javax.swing������������package.html������package-info.java����@serial exclude��������������������������public������java.security.BasicPermission��@serial exclude��������������������������package-private������java.util.PropertyPermissionCollection��@serial include�������������������������� ����������������@serial��������������������������@serial����������������������������

@serialData data-description

JDK 1.2������ ������������������������������������������������������������������������������������������������������writeObject����������������������������������������������������Externalizable.writeExternal������������������������������������������(��������������������)�������������� @serialData��������writeObject��readObject��writeExternal��readExternal��writeReplace������readResolve��������������������������������������������������������

@serialField field-name field-type field-description

JDK 1.2������ Serializable��������serialPersistentFields����������ObjectStreamField��������������������������������������ObjectStreamField��������������������1����@serialField������������������

@since since-text

JDK 1.1������ ������������������������������since-text����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������since-text������������������������������������������������������������������������������������������@since 1.5������ Java����������������������������������������@since��������Java����������������API��������������������������������������������������������������������������������������������������������@since����������������������@author����������������������������������������������API��������������������������������������������

@throws class-name description

JDK 1.2������ @exception������������������������Javadoc����������Doc��������������������@throws���������� (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@exception)������������������ @throws��������������������������Throws��������������������class-name������description������������������������class-name����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������javadoc����������������������������������������������������@throws����������������������������������������������������������������������������������������@see������������������������������������ ��������������������������������������������������������������@throws������throws��������������������������������@throws��������������������������������������javadoc����������������������HTML������������������������������ ����������������������������������������������������������������������@throws����������������������������������������������������������������������������������������������������������������������������������{@inheritDoc}����������������@throws��������������������������������������������������������

{@value package.class#field}

JDK 1.4������ ����������������������{@value}��������������������������������������������������������������������������������������������������������������

.\}

/**
 * The value of this constant is {@value}.
 */
public static final String SCRIPT_START = "<script>"
 
.\} ��������������������������������������������package.class#field����������������������{@value}��������������������������������������

.\}

/**
 * Evaluates the script starting with {@value #SCRIPT_START}.
 */
public String evalScript(String script) {}
 
.\} ����package.class#field����@see�������������������������������������������������������������������������������������� �������������������������������������� (http://docs.oracle.com/javase/8/docs/api/constant-values.html)����������������

@version version-text

JDK 1.0������ -version����������������������������������������������������������������������������������������������version-text����������������������������������������������������������������������������������������������������������������������@since��������������������������������������������������������version-text��������������������������������������Javadoc����������Doc��������������������@version���������� (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@version)������������������ 1������������������������������������������@version������������������������������������������1����@version������1��������������������������������������������������������������������������������������������javadoc��������������������������������������(,)��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������1������������������������������

"��������������������"

������������������������������������������������������������������������������������������������������������������@see��@since��@deprecated��{@link}��{@linkplain}������{@docroot}��

"��������"

��������������������������������������������������������������������������(������������������������������������������overview.html����������������������������������������)��������������������������������������������������������������������������������������������������������

����: Java SE 1.2��������������������������{@link}������bug����������������������������������������������������������������������������������{@docRoot}��������������������������������������������

����������������������������

@see reference || @since since-text || @serialField field-name field-type field-description || @author name-text || @version version-text || {@link package.class#member label} || {@linkplain package.class#member label} || {@docRoot} ||

"����������������"

������������������������������������������������������������������������������������������������������������������package.html������package-info.java����������������������������������������������������������@serial��������include������exclude����������������������������

������������������������������������

@see reference || @since since-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@linkplain package.class#member label} || {@linkplain package.class#member label} || {@docRoot} ||

"��������������������������������"

��������������������������������������������������������������������������������������������@serial��������include������exclude��������������������������������������������������������������������������������������

@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@link package.class#member label} || {@linkplain package.class#member label} || {@docRoot} ||

��������������������:

.\}

/**
 * A class representing a window on the screen.
 * For example:
 * <pre>
 * Window win = new Window(parent);
 * win.show();
 * </pre>
 *
 * @author Sami Shaio
 * @version 1.13, 06/08/06
 * @see java.awt.BaseWindow
 * @see java.awt.Button
 */
class Window extends BaseWindow {
 ...
}
 
.\}
"����������������"

������������������������������������������

@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @serialField field-name field-type field-description || {@link package.class#member label} || {@linkplain package.class#member label} || {@docRoot} || {@value package.class#field}

������������������������:

.\}

 /**
 * The X-coordinate of the component.
 *
 * @see #getLocation()
 */
 int x = 1263732;
 
.\}
"������������������������������"

������������������������������������������������������������������������������������������������������@return�������������������������������� {@inheritDoc}��������������������

@see reference || @since since-text || @deprecated deprecated-text || @param parameter-name description || @return description || @throws class-name description || @exception class-name description || @serialData data-description || {@link package.class#member label} || {@linkplain package.class#member label} || {@inheritDoc} || {@docRoot}

����: @serialData��������writeObject��readObject��writeExternal��readExternal��writeReplace������readResolve������������������������������������������������������������

����������������������:

.\}

/**
 * Returns the character at the specified index. An index 
 * ranges from <code>0</code> to <code>length() - 1</code>
 *
 * @param index the index of the desired character.
 * @return the desired character.
 * @exception StringIndexOutOfRangeException 
 * if the index is not in the range <code>0</code> 
 * to <code>length()-1</code>
 * @see java.lang.Character#charValue()
 */
 public char charAt(int index) {
 ...
 }
 
.\}
"����������"

javadoc����������������������������������������������������javadoc������������-doclet��������������������������������������������������������������������������������������������������������javadoc����������������������������������������������������������������������������������������������������������������Javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} Javadoc����������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������������������������������

����������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -1.1

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -author

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -bootclasspath classpathlist

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -bottom text

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -breakiterator

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -charset name

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -classpath classpathlist

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -d directory

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -docencoding name

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -docfilesubdirs

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -doclet class

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -docletpath classpathlist

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -doctitle title

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -encoding

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -exclude packagename1:packagename2:...

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -excludedocfilessubdir name1:name2

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -extdirs dirist

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -footer footer

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -group groupheading packagepattern:packagepattern

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -header header

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -help

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -helpfile path\efilename

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -Jflag

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -javafx

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -keywords

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -link extdocURL

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -linkoffline extdocURL packagelistLoc

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -linksource

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -locale language_country_variant

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -nocomment

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -nodeprecated

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -nodeprecatedlist

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -nohelp

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -noindex

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -nonavbar

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -noqualifier all | packagename1:packagename2...

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -nosince

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -notimestamp

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -notree

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -overview path/filename

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -package

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -private

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -protected

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -public

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -quiet

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -serialwarn

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -source release

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -sourcepath sourcepathlist

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -sourcetab tablength

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -splitindex

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -stylesheet path/filename

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -tag tagname:Xaoptcmf:"taghead"

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -subpackages package1:package2:...

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -taglet class

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -tagletpath tagletpathlist

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -title title

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -top

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -use

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -verbose

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -version

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -windowtitle title

��������������������������������������������������������Javadoc��������������������������������������������������������������������������-bootclasspath��-breakiterator��-classpath��-doclet��-docletpath��-encoding��-exclude��-extdirs��-help��-locale��-overview��-package��-private��-protected��-public��-quiet��-source��-sourcepath��-subpackages������-verbose��

"Javadoc����������"

-overview path/filename

javadoc������������������path/filename ��������������������������������������������������������������������������������������������������(overview-summary.html)����������������������������path/filename������������������������������������������ filename��������������������������path��������������������������������������overview.html������������������������������������������������������������������������������������������������������������������������������������������������������������path��������������������������������������-sourcepath������������������������������������������������������ ����������java.lang����������������������������/src/classes/java/lang/����������������������/src/classes/overview.html�������������� ���������������������������� path/filename������������������������������������������������������������������������ ��������������������������������javadoc����������������������������������������������������������HTML��������������������������������������������������������-doctitle����������������������

-Xdoclint:(all|none|[-]<group>)

����������������������������������������Javadoc����������������������������������������Javadoc����������������������HTML������������������������������ ����������������������javadoc������������������������������������������������������������������������������������������������������������-public��-protected��-package������-private������������������������������������������ -Xdoclint��������������������������javac����������������������������������������������������javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������Javadoc������������������javadoc����������������HTML����������������������������������������������������������������������������������������HTML������������������javadoc����������������HTML���������������������������������������������������������������������� ����������������-Xdoclint������������������������������������������-Xdoclint:none���������������� -Xdoclint������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -Xdoclint none: -Xdoclint��������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -Xdoclint group: group������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -Xdoclint all: ������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -Xdoclint all,-group: group������������������������������������
����group������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} accessibility: ��������������������������������������������������������(����������<table>����������������no caption������summary����)��

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} html: ������������������������������������������������������������������������������������������HTML������������������������������HTML 4.01����������������������������������������������javadoc������������������������������������������������������HTML��������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} missing: ������������Javadoc����������������������������������(����������������������������������������������������������@return����������������������������)��

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} reference: Javadoc������Java API����������������������������������������(����������@see��������������������������@param����������������)��

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} syntax: ������������������������������(<������>)��������������(&)��������Javadoc����������������������������������������
-Xdoclint������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������filename������������HTML����������������������������������������������������

.\}

javadoc -Xdoclint:html -Xdoclint:syntax -Xdoclint:accessibility filename
javadoc -Xdoclint:html,syntax,accessibility filename
 
.\} ����: javadoc��������������������������������������������������������������������������HTML������������������������������������������-Xdoclint��������������������javadoc���������������������������������������������������������������� javadoc��������������������������������������������������������������

-public

public������������������������������������

-protected

protected������public����������������������������������������������������������

-package

package��protected��������public����������������������������������

-private

��������������������������������������

-help

��������������������������������javadoc������������������������������������������������������

-doclet class

����������������������������������������������������������������������������������������������������������������������������������������������������������������������-doclet����������������������������������javadoc��������������������������������������������������HTML��������������������������������start(Root)��������������������������������������������������������������-docletpath�������������������������������������������������� (http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/doclet/overview.html)������������������

-docletpath classpathlist

-doclet������������������������������������������������������������������������������������������JAR����������������������������������������������������JAR��������������������������������������JAR��������������������������������������������������������������������������������������������classpathlist��������������JAR������������������������������������Solaris��������������(:)����Windows������������������(;)������������������������������������������������������������������������������������������������������������������������������ (http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/doclet/overview.html)������������������

-1.1

Javadoc 1.4��������������������������������������������������Javadoc 1.1��������������������������������������������������������������������������������(������������������������������������������)��������������������������������Javadoc 1.2������1.3����������������������������

-source release

������������������������������������������������release������������������������������������javac������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������: 1.5��javadoc������������JDK 1.5��������������������������������������������������������������-source����������������������������������������������������������������1.5������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������: 1.4��javadoc������������JDK 1.4����������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������: 1.3��javadoc������������JDK 1.3��������������������������������������������������������������������������

-sourcepath sourcepathlist

������������������-subpackages������������javadoc���������������������������������������������������������������������������� ������������������(:)�������������� javadoc���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������� -sourcepath����������������������������javadoc������������������������������������������javadoc��������������������������������������������������������������������������������������������������������������������1����������������������������������������������������������������������������-sourcepath������������������javadoc��������������������������������������������������������������(-classpath������)��������������-sourcepath��������������������������-classpath������������������������javadoc������������������javadoc����������������������������(��������������������������)���������������������������������� sourcepathlist�������������������������������������������������������������������������������������� ����������com.mypackage������������������������������������������������������������������������/home/user/src/com/mypackage/*.java������������������������������com\emypackage����������������������/home/user/src������������������������������������������������������

.\}

javadoc -sourcepath /home/user/src/ com.mypackage
 
.\} ������������������������������������������������������������(/)���������������������������������������������������������� /home/user/src/com/mypackage 2��������������������������������������������������

.\}

javadoc -sourcepath /home/user1/src:/home/user2/src com.mypackage
 
.\}

-classpath classpathlist

javadoc������������������������������������������������������������������������������������������������������������������������������������������������������������������������ ������������������(:)�������������� javadoc����������������������������������������������������������������������classpathlist���������������������������������������������������������������������������� -sourcepath������������������javadoc����������-classpath��������������������������������������������������������������(����������������)������������������������������������������������������������������������������-sourcepath��-classpath�������������������� ����������com.mypackage��������������������������������������������������������������/home/user/src/com/mypackage������������������������/home/user/lib��������������������������������������������������������

.\}

javadoc -sourcepath /home/user/lib -classpath /home/user/src com.mypackage
 
.\} ��������������������-classpath������������������������CLASSPATH����������������������������javadoc������������������������������������������������������������������javadoc���������������������������������������������������� javadoc����������-classpath������������������������������������������������������������������������������������������������������������������������������ (http://docs.oracle.com/javase/8/docs/technotes/tools/findingclasses.html)�������������������� *������������������������������������.jar������.JAR���������������������������������������������������������������������������������������� ����������������������mydir��a.jar��b.JAR������������������������������������foo/*��A.jar:b.JAR������������������JAR������������������������������������������������������������������������������������������JAR������������������������������*����������������������������������������������������������������JAR��������������������������������CLASSPATH��������������������������������������������������������������������Java Virtual Machine (JVM)����������������������Java��������������System.getenv("CLASSPATH")��������������������������������������������������������������������������������������������������

-subpackages package1:package2:...

������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������package����������������������������������(java����)������������������������(javax.swing����)����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������-sourcepath�������������������������������������������������������������������������������������������������������������������������������������������������������������� ��������������������������java������javax.swing������������������������������������������������������������������������������

.\}

javadoc -d docs -sourcepath /home/user/src -subpackages java:javax.swing 
 
.\}

-exclude packagename1:packagename2:...

������������������������������������������-subpackages����������������������������������������������������������������-subpackages���������������������������������������������������������������������� ������������java.io��java.util��java.math������������������������java.net��java.lang����������������������������������������java.lang����������������������java.lang.ref����������������������������������

.\}

javadoc -sourcepath /home/user/src -subpackages java -exclude 
 java.net:java.lang
 
.\}

-bootclasspath classpathlist

��������������������������������������������������������������������Java������������������������������������bootclasspath����javadoc������������������������������������������������������������������������������������������������������������ (http://docs.oracle.com/javase/8/docs/technotes/tools/findingclasses.html)������������������ classpathlist����������������������������������������(;)��������(Windows������)����������(:)������������(Oracle Solaris������)��

-extdirs dirist

����������������������������������������������������������������������Java������������������������������������������extdirs��������������javadoc��������������������������������������������������������������������������������������������-classpath������������������������������dirlist������������������������������(;)��������(Windows������)����������(:)������������(Oracle Solaris������)��

-verbose

javadoc������������������������������������������������verbose��������������������������������������������������������������������������(����������������������1��������������)��������������������������������������������verbose��������������������������Java����������������������������������(����������)��������������������������������������

-quiet

����������������������������������������������������������������������������������������version��������������������

-breakiterator

��������������������������������������������������������������������������������������java.text.BreakIterator������������������������������������������������������������������������������������������������������������������BreakIterator��������������������������������������������������������������������������������������������������������������������������������������JDK 1.2������BreakIterator��������������������������������������������������������������������������������������������������-breakiterator��������������1.2����������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ������������������������������������������������������HTML��������������(<P>����)����������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} breakiterator����������������������������������������������������������������������������������������������������������������������������������The serial no. is valid����������������������������������������������Mr. Smith��������������������-breakiterator����������������HTML��������������������������������������������������HTML������������������������������������������������../filename��������������������������������
Java SE 1.5����-breakiterator����������������������������������������������������������������������������������������������������������SE 1.4.x����-breakiterator��������������������������������������������������������������������Java SE 1.5.0����������������������������

-locale language_country_variant

javadoc��������������������������������������������������������������������������������java.util.Locale����������������������������������en_US (����������)������en_US_WIN (Windows����������)�������������������������� ����: -locale������������������������������������������������������������������������������������������������������������������������������(����)������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������ ������������������������������������������������������������javadoc��������������������������������������(������������������������������������������������������������������stylesheet.css����������������������)������������������������������������������������������������������������������������������������������������������������������������������������������������������������-locale������������������������������������������������������������������������������������������������������������������������������������������������������������

-encoding

����������������������������������������(EUCJIS/SJIS����)��������������������������������������������������������������������������������������������������������������������������������������������������

-Jflag

javadoc������������������Java Runtime Environment (JRE)����flag��������������������������������������������������������������������32MB������������������������������������������-Xmx������������������������������������javadoc -J-Xmx32m -J-Xms32m com.mypackage��-Xms�������������������������������������������������������������������������������������������������������������������������� J��flag���������������������������� ������������javadoc����������������������������������-version����������������������������������������������������������������������������������������Javadoc����������������������������������

.\}

javadoc -J-version
java version "1.7.0_09"
Java(TM) SE Runtime Environment (build 1.7.0_09-b05)
Java HotSpot(TM) 64-Bit Server VM (build 23.5-b02, mixed mode)
 
.\}

-javafx

������������������������JavaFX��������������������HTML����������������������������������������������������������Java����������������������������������������������������������������������������������������������������������������������������������������������������getter������setter�������������������������������������� getter������setter����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������@defaultValue������������������ ��:

.\}

javadoc -javafx MyClass.java -d testdir
.\}
"����������������������������"

-d directory

javadoc��������������������HTML��������������������������������������������������-d��������������������������������������������������������������������directory����������������������������������������������������������������������������������������������Java SE 1.4������javadoc�������������������������������������������������������������� ����������������������com.mypackage����������������������������������������������/user/doc/����������������������������javadoc -d /user/doc/ com.mypackage

-use

������������������������������������������������1������������������������������������������������������������������������������������API������������������������������������������������������������������������������������������������������������C��������������������C����������������������������C��������������C��������������������������������C������������������������C����������������������������������������������������������������String������������������������������������java.awt.Font��������getName����������String��������������getName����������String����������getName����������String����������������������������������������������������API������������������������������������������������������String����������������������������������������������������������������������������String����������������������������������������������������������������������������������������������������������������������������������������������������������

-version

��������������������@version����������������������������������������������������������������������������������javadoc����������������������������������-J-version������������������������

-author

��������������������@author��������������������������

-splitindex

��������������������������������������������������������������������1����������������������������������������������������������������1��������������������������

-windowtitle title

HTML��<title>������������������������������������title����������������������������������������������������������������������������������������������������(����������)��������������������������������HTML������������������������������������HTML������������������������������������������������������������title����������������������������������������������������������������-windowtitle������������������������javadoc������������-windowtitle����������������������-doctitle��������������������������������������javadoc -windowtitle "Java SE Platform" com.mypackage������

-doctitle title

��������������������������������������������������������������������title����������������������������������������������1��������������������������������������������������������������title��������HTML��������������������������������������������������������������������������������������������title����������������������������������������������������������������������������javadoc -header "<b>Java Platform </b><br>v1.4" com.mypackage.������������

-title title

��������������������Javadoc 1.2����������������������������������������������������������-doctitle����������������������������������������������������������������������������������������������������������������������������������������������������������

-header header

����������������������������������������������������������������������������������������������������������������������header����HTML������������������������������������������������������header��������������������������������������������������������������������������������������������javadoc -header "<b>Java Platform </b><br>v1.4" com.mypackage.������������

-footer footer

����������������������������������������������������������������footer��������������������������������������������������footer����HTML������������������������������������������������������footer����������������������������������������������������������������������������������

-top

������������������������������������������������������

-bottom text

��������������������������������������������������������������������������������������������������������������������������������������������������HTML������������������������������������������������������������������������������������������������������������������������������������������������

-link extdocURL

������Javadoc��������������������������������������������������������������������extdocURL��������������������������������Javadoc��������������������������������������������������������URL����������URL��������������javadoc������������������������-link���������������������������������������������������������������� ��������������������package-list��������������������������������(������������������-linkoffline����������������������)��javadoc������������package-list��������������������������������������������URL������������������������������������javadoc��������������������extdocURL������������������<A HREF>��������������������������������������extdocURL����������������������������������URL����������������������extdocURL��������������������������������������������������������Web����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������(-d����������������)����������������������������������HTTP����������������������������Web������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������URL����������������������������������http:������file:��������������URL����: Uniform Resource Locators (http://www.ietf.org/rfc/rfc1738.txt)����������������������������������������������������������������

.\}

-link http://<host>/<directory>/<directory>/.../<name>
-link file://<host>/<directory>/<directory>/.../<name>
-link <directory>/<directory>/.../<name>
 
.\}

-linkoffline������-link����������������

������������-link������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����API����������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����API��������������������URL��������������(����URL������������������������������������������������������������)��

����API��������������������URL��������������(����URL��������������������������������������������������������������)��-linkoffline��������������������������������������������������������������������������������������������������������������������������������������������������

�� 1 ������������������������������

http://docs.oracle.com/javase/8/docs/api/index.html��������������java.lang��java.io��������������Java����������������������������������������������������������������������

.\}

javadoc -link http://docs.oracle.com/javase/8/docs/api/ com.mypackage
 
.\} ����������������Java SE������������������������������������������com.mypackage��������������������������������������������������������������������������trees����Object����������������������������������-sourcepath��-d��������������������������������������

�� 2 ������������������������������

������������2����������������������������������������javadoc������������������������������������������������������������������������������������������������������������������������API������com.apipackage����SPI(������������������������������������)������com.spipackage������������������������������docs/api/com/apipackage��docs/spi/com/spipackage������API������������������������������������������������docs��������������������������������API����������������������������SPI��������������������������������������������������������������javadoc -d ./spi -link ../api com.spipackage -link������������������������������(docs/spi)��������������������

����

-link������������������������������������������������������������javadoc������������������������������������������������������������������������������������������������������������������������������HTML����������������������������������extdocURL����������������������������������������������������������������������������java.*��������������������( http://docs.oracle.com)����������������������������javadoc������������������������������������������������������������API����������������������������������-link������������������������-link��������������������������javadoc����������������������������������������������������������������������������������������������������������������������������������������������������������������-link����������������������������������������������������������������������������������������������������������������������������1����������������������������������������������������������������������������������������������������javadoc������������������������������������������������������javadoc��������������������������������������������������������������������

����������������

����������������������������������������(��������������������������������������)����������������������������������������������������������������������������������������������������������import��������������������������������������������������������java.io.File������������������������������

����������������import������������������������������������������������������������������������������java.lang.*������������������������

Java SE 1.3.n������1.2.n����������������������������������������������������������������������import������import java.lang.*��������������������������������

����������: void mymethod(File f) {}

������������������������������������������������������������������������������������������������������������������������������������������������������

������������������-link����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

������������������

-link����������������javadoc��������������������������package-list������������������������-link��������������������URL������������������������������package-list��������������������������������������������������������������������������������������������������������������������������javadoc��������������������URL��package-list������������������������������������������������������������URL������������������������������������

����������Java SE API���������������������� http://docs.oracle.com/javase/8/docs/api/package-list������������

��������������������������������������������������������

.\}

java.applet
java.awt
java.awt.color
java.awt.datatransfer
java.awt.dnd
java.awt.event
java.awt.font
and so on ....
 
.\}

-link����������������������javadoc������������������������������������������������������������������������������������������������-link��������������������������javadoc����������������������extdocURL������������package-list������������������������������������������������������������������extdocURL��������������������������

����������������������������������������������������������������������������������URL��������������������������javadoc����������������������package-list����������������������������������������������������������������������������������������

������������

������-link��������������������������������������������������������������������������������Javadoc 1.2������������-link������������������������������������bug������������������Javadoc 1.2.2����������������������������������������������������������������������������������������������������javadoc -link extdocURL1 -link extdocURL2 ... -link extdocURLn com.mypackage extdocURL1��extdocURL2��... extdocURLn����������������������������������������������������������package-list������������������������������������

������������

��������������������������������������������������������������������������������������������������������������������������������package-list��������������������������������������������������javadoc��������������������������2��������������������package-list��������������������������������������������������������������2����������������������������������������������������������������������������������

������������������������������������������package-list������������������(������������������������������������������������������������)��������2������������������������������������������������������������package-list����������������������������javadoc��������������������������������

-linkoffline extdocURL packagelistLoc

����������������-link������������������������������������������Javadoc��������������������������������������������������������������������javadoc����������Web��������������������������������������������������Web����������������������������������-linkoffline������������������������������������������package-list����������������������������������������������������extdocURL������������������������������packageListLoc��������������������(������������)����������������-linkoffline������������������������extdocURL��World Wide Web��������������������������������-linkoffline������������������������������������������������������javadoc����������Web��������������������������������������������������1����������������������������������������������������������������������������������������������������javadoc����������������������������������������������������������javadoc������������������������������������������������������������������������������������������������������������-linkoffline������������������2��������������1������<a href>��������������������������������������2������package-list������������-linkoffline������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} extdocURL��������������������������������Javadoc��������������������������������������������������������URL����������URL����������URL��������������������������������(-d����������������)������������������������������������������������������������������������������-link������������extdocURL��������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} packagelistLoc��������������������������package-list����������������������������������������URL��������������URL (http:������file:)��������������������������������������������������������������������������������������������������������javadoc����������������������������������������������������������������������package-list�������������������������������� ��������javadoc������������������������-link��������������������������Javadoc 1.2.2������������-linkfile������������1����������������������������

������������������������������

http://docs.oracle.com/javase/8/docs/api/index.html��������������java.lang�� java.io��������������Java SE������������������������������������������������

������������������Web������������������������������������������������

\h'-04' 1.\h'+01'\c .\}

" 1." 4.2
.\} ����������package-list������������������(http://docs.oracle.com/javase/8/docs/api/package-list)

\h'-04' 2.\h'+01'\c .\}

" 2." 4.2
.\} ������������������������������������������������������������������2����packagelistLoc������������������������������������������������������������������������������(.)��������������������

����������������Java SE��������������������������������������������com.mypackage��������������������������������������������������������������������������trees����Object����������������������������������-sourcepath��������������������������������������������

.\}

javadoc -linkoffline http://docs.oracle.com/javase/8/docs/api/ . com.mypackage 
 
.\}

������������������������������

-linkoffline����������������������������������������������������������������������-link��������������������-linkoffline��������������������������������package-list������������������������������������������������������������������������������������������-linkoffline������������2��������������������������������������������������2����������������������-link��������������������������

package-list����������������������

package-list����������������������������������������������������������������������������������������������������������������������������packagelistLoc������������������������������������com.apipackage������������������������com.spipackage����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������package-list����������������������Javadoc 1.0������1.1��������������������������package-list������������������������������������������������������������2������������������package-list������������������������������������������������������������������������������������������������������

��������������������������

������������������������������1����-linkoffline����������������������������������

.\}

javadoc -linkoffline extdocURL1 packagelistLoc1 -linkoffline extdocURL2
packagelistLoc2 ...
 
.\}

������������������

������������������������������������������������������������-linkoffline����������������������������������������������������javadoc������������������������������������������������������������������������������������������������������������������javadoc������������������������������������2������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

����������������������������������������������������������������(update����)��������������������������������������������������������html������������������������html������������������������������������������-linkoffline��������������1����������������������������(.)������������2������package-list������������html����������������������������������������������������������������������

.\}

javadoc -d update -linkoffline . html com.mypackage
 
.\}

javadoc������������������update/com/package��������������������������������������(����������������)��html/com/package��������������������������������

-linksource

������������������(����������)��HTML������������������������HTML���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������� ������������������-public��-package��-protected������-private������������������������������������������������������������������������������������������������������������������������������������������������������������������-private������������������������������������������������������������������������������������������������������������������������������ ��������������������������������������������������������������Button������������������������������������Button����������������������������

.\}

public class Button extends Component implements Accessible
 
.\} Button��������getLabel��������������������������������������getLabel����������������������������

.\}

public String getLabel()
 
.\}

-group groupheading packagepattern:packagepattern

������������������������������������������������������������������������������������������������������������������-group��������������������������������������������������������������������������������������������������������������������������������������������������������-group����������������packagepattern����������������������������������������������groupheading������1����������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} groupheading��������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} packagepattern��������������������������������������������������1����������������(*)��������������������������������������������������������������������������������������������������������������������������1������������������������(:)������������������������������������������������������������������������������������������������������������������������������"java.lang*:java.util"������������������������������������
-group������������������������������������Packages��������������������������1����������������������������������������������������������������������������(����������������)�������������������������������������������������������������������������������������������������������������������������� ��������������javadoc��������������3��������������������������������������������������������������������������������������������������java.lang*������������������(.)��������������������java.lang.*�������������������������� java.lang��������������������������������������

.\}

javadoc -group "Core Packages" "java.lang*:java.util"
 -group "Extension Packages" "javax.*"
 java.lang java.lang.reflect java.util javax.servlet java.new
 
.\} ���������������� java.lang java.lang.reflect java.util ������������������ javax.servlet Other Packages java.new

-nodeprecated

��������API��������������������������������������������������������������������-nodeprecatedlist����������������������������������������������������������������������������������API������������������������������������������������������������������������������������������������������������������������

-nodeprecatedlist

��������API����������������������(deprecated-list.html)������������������������������������������������������������������������������javadoc������������������������������������������������������������API������������������������������������������API����������������������������������������������������������������������������������������

-nosince

����������������������@since��������������������������������������������������������������������

-notree

��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

-noindex

����������������������������������������������������������������������������

-nohelp

������������������������������������������������������������������������������������������

-nonavbar

��������������������������������������������������������������������������������������������������������������������������-nonavbar������������-bottom������������������������������-nonavbar������������������������������������������PostScript��PDF��������������������������������������������������������������������������������

-helpfile path\efilename

����������������������������������������������������������������������������������������������path\efilename��������������������������������������������������������javadoc������������javadoc��������������������������������������������������help-doc.html������������������������������������������������������������������������������������������������������������������������help-doc.html������������������javadoc������������������������������������������������������������������������������������

.\}

javadoc -helpfile /home/user/myhelp.html java.awt.
 
.\}

-stylesheet path/filename

����HTML��������������������������������������������������������������������������������javadoc������������javadoc����������������������������������������������������������stylesheet.css������������������������������������������������������������������������������������������������������������������������stylesheet.css������������������

.\}

javadoc -stylesheet file /home/user/mystylesheet.css com.mypackage
 
.\}

-serialwarn

@serial������������������������������������������������������������������Javadoc 1.2.2��������������������������������������������������������������������������������������������������������������������������������������������������������������������writeExternal��������������������������������������������������

-charset name

��������������������HTML������������������������������������IANA Registry��Character Sets (http://www.iana.org/assignments/character-sets)����������������MIME������������������������ ����������javadoc -charset "iso-8859-1" mypackage����������������������������������������������������

.\}

<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 
.\} ����META��������HTML����(4197265������4137321)��HTML Document Representation (http://www.w3.org/TR/REC-html40/charset.html#h-5.2.2)�������������������� ������������������������������������

-docencoding name

����������HTML����������������������������������������������������IANA Registry��Character Sets (http://www.iana.org/assignments/character-sets)����������������MIME������������������������ -docencoding��������������������-encoding����������������������������������HTML������������������-encoding����������������������������: javadoc -docencoding "iso-8859-1" mypackage������������������������������������

-keywords

HTML����������<META>��������������������������������������������������������������������<META>����������������������������������������������������������������������������������������������������������������������<META>��������������������������������������������������������������������Web��������������������������������������������������������������<META>������������������������������������������������<META>��������������������������������������������������������������������������������������������������������������������������������������������������������������������String������������������������������

.\}

<META NAME="keywords" CONTENT="java.lang.String class">
<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">
<META NAME="keywords" CONTENT="length()">
<META NAME="keywords" CONTENT="charAt()">
 
.\}

-tag tagname:Xaoptcmf:"taghead"

javadoc��������������������������������������������������1������������������������������������@tagname��������������������������������������javadoc������������������������������������������������������������������������������������������������������������������-tag����������������������������������������������������������������������X����������������������-tag��������������������������taghead����������������������������������������������������1����������������������������������������������������������������������������������������������������������������������������������������������������������������������������1����������������(@return��@author����)������������������������taghead������������������tagname���������������������������� ����������: Xaoptcmf��������������������������������������������������������������������������������������(X����������)����������������������������������������������a������������������������������������������������ X (������������) a (������) o (����) p (����������) t (������������������������������������) c (��������������) m (��������) f (����������) ������������������: ������������������������������������������������������������������������������-tag todo:a:"To Do:" @todo������������������������������������������������������������������-tag todo:cmf:"To Do:"�������������� ������������(:)����������������������������������������������������������������������@todo��������������������������������������������������������������������������������@todo The documentation for this method needs work������ ����������������: ��������������������������������������������������������������������������������������������������������������������-tag ejb\e\e:bean:a:"EJB Bean:"������������������������

.\}

/**
 * @ejb:bean
 */
 
.\} ����������������������: ����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������X����������������������������������������������������������������������������������javadoc����������������������������������������������������������������������������������������������������javadoc��������������������������������������������������������X��������������������������������X����������������������������������������������������������@todo��������������������������-tag todo:Xcmf:"To Do:"������������������������������������-tag todo:X������������������-tag todo:X����@todo���������������������������������������������� ����������: -tag������-taglet������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������-tag��������������������������-taglet����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������-taglet������-tag����������������todo������������������������������������������������������������������ ��������������������: ������������������Parameters��Throws������To Do��������������X������������@example��������������������������������������������������������������������������������@argfile������������������������������������������������������������������������������(������������������������)��

.\}

-tag param
-tag return
-tag todo:a:"To Do:"
-tag throws
-tag see
-tag example:X
 
.\} javadoc������������������������������������������������������������������������������������������-tag��-taglet�������������������������������������������������������������������������������������� ��������������������������������������������������������������������-tag����������������������������������������������������������������������������������������������������������������������������������-tag�������������������������������������������������������������������������� ����������: ��������������������������������������������������������com.mycompany.todo������������������������������������������������Oracle��������������������������������������������������������������������������������Oracle������������������������������������������������������@todo������������������������������������������������������������������Oracle������������������������������������������������������������������������������������������������������������ ����vs. Javadoc����: ������������������������������������������������������������������������������������������������������������������������������������������Javadoc��������������������������������������������Javadoc����������Doc�������������������������������������������������� (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#annotations)�������������������� -taglet������������������������������������������������������������������������������������������

-taglet class

������������������������������������������������������������������������������������������������class���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������� (http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/taglet/overview.html)�������������������� ������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������-tagletpath������������������������������������������������Parameters��Throws������To Do������������������������������������������-taglet����������������-tag������������������������������������������������������������������������������������

.\}

-taglet com.sun.tools.doclets.ToDoTaglet
-tagletpath /home/taglets 
-tag return
-tag param
-tag todo
-tag throws
-tag see
 
.\}

-tagletpath tagletpathlist

taglet������������������������������������������������������tagletpathlist������������(:)��������������������������������������������javadoc����������������������������������������������������������������������

-docfilesubdirs

doc-files����������������������������������������������������������������������������������������������������������������������������������������oc-files/example/images��������������������������������������������������������������������������������������

-excludedocfilessubdir name1:name2

����������������doc-files������������������������������������������������SCCS����������������������������������������������������������������

-noqualifier all | packagename1:packagename2...

����������������������������������������������������-noqualifier��������������������all(������������������������������)����������������������������������������������������������(������������������)���������������������������������������������������������������������������������������������������������������������������������������������� ��������������������������������������������������-noqualifier all ������������java.lang������java.io����������������������������: -noqualifier java.lang:java.io�� ������������java������������������������������com.sun������������������������������javax����������������-noqualifier java.*:com.sun.* ����������������������������������������������������������������������������������������������������������������������������������������-noqualifier��������������������������������������������������

-notimestamp

������������������������������������������������������������������HTML����HTML��������������������������������������-notimestamp��������������javadoc����������2��������������������������������������������diff������������������������������������������������diff��������������������(����������������������������diff����������)��������������������javadoc������������������������������������������<!-- Generated by javadoc (build 1.5.0_01) on Thu Apr 02 14:04:52 IST 2009 -->����������������������

-nocomment

��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������HTML����������������������������������������

-sourcetab tablength

����������������������������������������������������

"����������������������"

javadoc��������������������������������������������javadoc��������������������(-J����������������)��������1������������������������������������������������������������������������������������������������������������������javadoc������������������������

������������������javac����������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

����������������������������������������������������������������������������������������������������������������������������������(*)����������������������������*.java��������������������������������(@)��������������������������������������������������������������-J��������������������������������������������������������������������������������������������������������������������������������������

javadoc����������������������������������������������������������@����������������������javadoc������������������������(@)����������������������������������������������������������������������������������

�� 1 ������������������

argfile������������1������������������������������������javadoc����������������������������javadoc @argfile������������������������������������������������������������������������������

�� 2 2����������������

������������2��������������������������������javadoc������������������������1��������������������������������������������1���������������������������������������������������� ����������������options����������������������������������

.\}

-d docs-filelist 
-use 
-splitindex
-windowtitle \*(AqJava SE 7 API Specification\*(Aq
-doctitle \*(AqJava SE 7 API Specification\*(Aq
-header \*(Aq<b>Java(TM) SE 7</b>\*(Aq
-bottom \*(AqCopyright &copy; 1993-2011 Oracle and/or its affiliates. All rights reserved.\*(Aq
-group "Core Packages" "java.*"
-overview /java/pubs/ws/1.7.0/src/share/classes/overview-core.html
-sourcepath /java/pubs/ws/1.7.0/src/share/classes
 
.\} ����������������packages����������������������������������

.\}

com.mypackage1
com.mypackage2
com.mypackage3
 
.\} ������������javadoc����������������������

.\}

javadoc @options @packages
 
.\}

�� 3 ��������������������������

����������������������������������������������������������������������(path1��path2��������)����������������������������������������������������

.\}

javadoc @path1/options @path2/packages
 
.\}

�� 4 ��������������

������javadoc������������������������������������������������������������������������������������������������-bottom������������������������������������������������������bottom������������������������������������

.\}

<font size="-1">
 <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/>
 Copyright &copy; 1993, 2011, Oracle and/or its affiliates. All rights reserved. <br/>
 Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 Other names may be trademarks of their respective owners.</font>
 
.\} javadoc�������������������������������� javadoc -bottom @bottom @packages -bottom��������������������������������������������������javadoc����������������������������������javadoc @bottom @packages
"JAVADOC��������������"

javadoc������������������������javadoc -J-version����������������������������������������������������������������������������������������-quiet����������������������������

Java������������������������������javadoc����������������������������������������������������������������������������������������������com.sun.tools.javadoc.Main����������(����javadoc����������������������)�������������������������� (http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/standard-doclet.html#runningprogrammatically)��������������������

������������������HTML������������������������������������������������������������������-doclet������-docletpath���������������������������������������� (http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/doclet/overview.html)������������������

"��������"

javadoc������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

������������������������������/home/src/java/awt/*.java��������������������������������/home/html������

1����������������������������������

������������������������������������������������������������������������������������������������������������������������������������������

��������������(java.awt.color��������������������������)��������������������������������������������������������������������������(ava/awt/color����)������������������������������

1��������������������������������������������������������������������������2��������������������������������������������������������������������������-sourcepath����������������������������������������������������������src1/java/awt/color��src2/java/awt/color��

������������������(cd��������������)������-sourcepath������������������javadoc��������������������������������������������������������

�� 1 1����������������������������������

����������javadoc��������������������������������������������������-sourcepath����������������������������-subpackages(1.4��������������)����������������������java��������������������������������������������java.net��java.lang����������������������������������������java.lang����������������������java.lang.ref����������������������������������������������������������������������������������java:javax:org.xml.sax������������������������������������-subpackages��������������������

.\}

javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude
 
.\}

�� 2 ��������������������������������������������

������������������������������������������������������������������������������1����������������������������������javadoc����������������������

.\}

cd /home/src/
javadoc -d /home/html java.awt java.awt.event
 
.\} ������������������������������������������������java:javax:org.xml.sax������������������������������������-subpackages��������������������

�� 3 1����������������������������������������������������������

����������������������������������������������������������javadoc������������������������������������������������������������-sourcepath������������������������������������������1��������������������������������������

.\}

javadoc -d /home/html -sourcepath /home/src java.awt java.awt.event
 
.\}

�� 4 ������������������������������������������������������������

javadoc������������������������������������������������������������������������-sourcepath������������������������������������������1��������������������������������������������������������������������������������������1������������������������������������������������������������������������������������������������������������������������

.\}

javadoc -d /home/html -sourcepath /home/src1:/home/src2 java.awt java.awt.event
 
.\} ����������������java.awt������java.awt.event��������������public������protected��������������������������������HTML������������������������������������������������������������HTML������������������������2������������������������������������������������������������������������������������������������������������������������������3����HTML������������������������������

1������������������������������

������1����������������������������������javadoc����������������������������������javadoc��������2����������������������������������1������������������������������(cd������)������1����������������������������������������������������������������������������������������������������������������������������������-sourcepath��������������������������������������(*)������������������������������������������������������������������������������

�� 1 ��������������������������

������������������������������������������������������������������1����������������������������������������javadoc���������������������� ������������Button��������Canvas��������������������Graphics������������������������HTML������������������������������������������������������������������������javadoc������������������������������������������������������������������������������������������2����������������������������������

.\}

cd /home/src/java/awt
javadoc -d /home/html Button.java Canvas.java Graphics*.java
 
.\}

�� 2 ��������������������������������������

��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������

.\}

cd /home/src/
javadoc -d /home/html java/awt/Button.java java/applet/Applet.java
 
.\}

�� 3 ������������������������������������������������

��������������������������������������������������������������������������������������������������������(��������������������������������������)����������javadoc����������������������

.\}

javadoc -d /home/html /home/src/java/awt/Button.java
/home/src/java/awt/Graphics*.java
 
.\}

��������������������������������������

������������������������������������������������������������������������������������������2��������������������������������-sourcepath��������������������������������������������������������������������������������������������������������

.\}

javadoc -d /home/html -sourcepath /home/src java.awt
/home/src/java/applet/Applet.java
 
.\}
"��������"

��������������������makefile������������javadoc����������Java����������������API��������������Java SE 1.2����1500����public������protected������������������������������������180MB��������������������������������������������������������������������������������������������������������������javadoc������������������������

��������������

������������������������������������������������������������������������������������������������������������������������������������������������������������������

������������packages����������������������������������java.applet java.lang����������������������������������������������������������������������������������������������������������������������������������������������-bottom������������������������������������������

.\}

javadoc -sourcepath /java/jdk/src/share/classes \e
-overview /java/jdk/src/share/classes/overview.html \e
-d /java/jdk/build/api \e
-use \e
-splitIndex \e
-windowtitle \*(AqJava Platform, Standard Edition 7 API Specification\*(Aq \e
-doctitle \*(AqJava Platform, Standard Edition 7 API Specification\*(Aq \e
-header \*(Aq<b>Java(TM) SE 7</b>\*(Aq \e
-bottom \*(Aq<font size="-1">
<a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/>
Copyright &copy; 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/>
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
Other names may be trademarks of their respective owners.</font>\*(Aq \e
-group "Core Packages" "java.*:com.sun.java.*:org.omg.*" \e
-group "Extension Packages" "javax.*" \e
-J-Xmx180m \e 
@packages
 
.\}

����������������������������������

Javadoc Access API��������������������������������������Javadoc��������Java��������������������������������������

��������������������������javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java.net:java.lang com.example������������

.\}

import javax.tools.DocumentationTool;
import javax.tools.ToolProvider;
 
public class JavaAccessSample{
 public static void main(String[] args){
 DocumentationTool javadoc = ToolProvider.getSystemDocumentationTool();
 int rc = javadoc.run( null, null, null,
 "-d", "/home/html",
 "-sourcepath", "home/src",
 "-subpackages", "java",
 "-exclude", "java.net:java.lang",
 "com.example");
 }
 }
 
.\}

run����������������3����������������������������������������������������������������������Null��System.in��System.out������System.err����������������������������

"makefile����"

����������GNU makefile����������������makefile��������������������������������Windows makefile����������������Javadoc FAQ��makefiles������������ (http://www.oracle.com/technetwork/java/javase/documentation/index-137483.html#makefiles)������������������

.\}

javadoc -sourcepath $(SRCDIR) \e /* Sets path for source files */
 -overview $(SRCDIR)/overview.html \e /* Sets file for overview text */
 -d /java/jdk/build/api \e /* Sets destination directory */
 -use \e /* Adds "Use" files */
 -splitIndex \e /* Splits index A-Z */
 -windowtitle $(WINDOWTITLE) \e /* Adds a window title */
 -doctitle $(DOCTITLE) \e /* Adds a doc title */
 -header $(HEADER) \e /* Adds running header text */
 -bottom $(BOTTOM) \e /* Adds text at bottom */
 -group $(GROUPCORE) \e /* 1st subhead on overview page */
 -group $(GROUPEXT) \e /* 2nd subhead on overview page */
 -J-Xmx180m \e /* Sets memory to 180MB */
 java.lang java.lang.reflect \e /* Sets packages to document */
 java.util java.io java.net \e
 java.applet
 
WINDOWTITLE = \*(AqJava(TM) SE 7 API Specification\*(Aq
DOCTITLE = \*(AqJava(TM) Platform Standard Edition 7 API Specification\*(Aq
HEADER = \*(Aq<b>Java(TM) SE 7</font>\*(Aq
BOTTOM = \*(Aq<font size="-1">
 <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/>
 Copyright &copy; 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/>
 Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 Other names may be trademarks of their respective owners.</font>\*(Aq
GROUPCORE = \*(Aq"Core Packages" "java.*:com.sun.java.*:org.omg.*"\*(Aq
GROUPEXT = \*(Aq"Extension Packages" "javax.*"\*(Aq
SRCDIR = \*(Aq/java/jdk/1.7.0/src/share/classes\*(Aq
 
.\}
"����"

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -windowtitle������������������������javadoc������������������������������������������������������������������������������-windowtitle������������������������-doctitle������������������������HTML����������������������������HTML������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} -footer������������������������javadoc��������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ����������������������������-classpath��-link������������������������
"������������������������������"

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} javadoc����������������������������������������������������������javadoc����������������������������������������������������������������������������������������������������������������������������������������

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ��������bug������������������������������������������������Javadoc FAQ (http://www.oracle.com/technetwork/java/javase/documentation/index-137483.html)��������������������
"������������"

��������������������������������������������������(��������������������������������������������������)����������������������

����������������������������: Class1.java����������������������javadoc����������Class1.java��������������������������������������������������������������������������������(��������������)����������������

"����"

CLASSPATH

CLASSPATH����javadoc������������������������������������������������������������������������������������������������-classpath������������������������������������������������������������������(Windows������)������������(Oracle Solaris������)�������������� Windows����: .;C:\eclasses;C:\ehome\ejava\eclasses Oracle Solaris����: .:/home/classes:/usr/local/java/classes

"��������"

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} javac(1)

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} java(1)

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} jdb(1)

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} javah(1)

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} javap(1)
"����������������"

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} Javadoc���������� (http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/index.html)

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ���������������� (http://docs.oracle.com/javase/8/docs/technotes/tools/findingclasses.html)

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} Javadoc����������Doc������������������ (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html)

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} URL������Uniform Resource Locators (http://www.ietf.org/rfc/rfc1738.txt)

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} HTML������HTML Document Representation (4197265������4137321) (http://www.w3.org/TR/REC-html40/charset.html#h-5.2.2)

'pl 8.5i 'bp