Documentation Contents

javadoc - Java API ????????????????????????????????????

Java ??????????????????????????????API ????????????????????? HTML ?????????????????????????????????????????????????????????????????????????????? Javadoc ????????????Sun Solaris ???????????????????????????????????????

??????

???????????????????????????

??????

???????????????????????????

??????

javadoc [ options ] [ packagenames ] [ sourcefilenames ] [ -subpackages pkg1:pkg2:... ] [ @argfiles ]

?????????????????????????????????????????????Javadoc ????????????????????????????????? .java ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

options
???????????????????????????????????????????????????????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????
packagenames
?????????????????????????????????????????????????????????????????? ???????????????java.lang java.lang.reflect java.awt ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ?????????????????????????????????-subpackages ?????????????????????Javadoc ???????????????-sourcepath ??????????????????????????????????????????????????????????????????1 ??????????????????????????????????????????????????????????????????????????????????????????
sourcefilenames
?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (*) ?????????????????????????????????????????????????????????????????? Javadoc ??????????????????????????????????????????????????????.java????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (???Identifiers????????????)???????????????????????????????????????????????? (X-Buffer ??????) ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????javadoc ???????????????????????????????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????????????? -sourcepath ???????????????????????????????????????????????????????????????????????????????????????????????? Button.java ?????????????????????./Button.java ?????????????????????????????????????????????????????????????????????????????????????????????/home/src/java/awt/Graphics*.java ??????????????????????????????1 ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
-subpackages pkg1:pkg2:...
???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
@argfiles
Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 1 ??????????????????????????????????????????????????????????????????????????????????????? (*) ????????? -J ??????????????????????????????????????????

??????

Javadoc ???????????????????????? Java ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? public ????????????protected ?????????????????????????????????????????? (?????????????????????????????????)??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? HTML ???????????????????????????????????????API (??????????????????????????????????????????????????????????????????) ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? -subpackages ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? javadoc ????????????????????????????????????????????? (.java) ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ?????????????????????????????????????????????????????????????????????

??????????????????????????????

Javadoc ???????????????????????? .java ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? Javadoc ??????????????????????????????????????? .java ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ???????????? 3 ??????????????????????????????????????????????????????(1) ??????????????????????????????(2) -subpackages ??????????????????(3) ??????????????????????????????????????????????????????????????? (*.java) ??????????????????????????????????????????????????????????????????Javadoc ???????????????.java ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

?????????????????? - Javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????? (??????????????????????????????) ?????????????????????????????????????????????????????????-link ????????? -linkoffline ???????????????????????????????????????

??????????????????????????????????????? - Javadoc ???????????????????????????????????? 1 ?????????????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????? ????????????Javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????Javadoc ????????????????????????????????????????????? java ?????????????????????????????????java ??????????????????????????????????????????Javadoc ???????????? javac ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? HTML ?????????????????????????????????Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

Javadoc ????????????????????????????????????????????????????????????????????????????????? .java ?????????????????????????????????????????????????????????????????????????????????????????????API ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? javadoc ?????????????????????????????????

???????????????????????????????????????????????????HTML ????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ???????????????.class ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (Java ?????????????????????????????? 8.6.7) ????????????????????????????????????

?????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Java ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????javac ???????????????????????????????????????Javadoc ????????????????????????????????????????????????????????????Javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????DocCheck ????????????????????????????????????????????????

Javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ???????????????????????????????????????????????????????????????

Javadoc ?????????????????????

Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????????HTML ????????? API ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????HTML???XML???MIF???RTF ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-doclet ???????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????????????????

??????

??????????????????????????????????????????????????????doc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????

???????????????????????? (generated document)
javadoc ???????????? Java ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? HTML ?????????????????????????????????????????????????????????????????????

?????? (name)
Java ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????java.lang.String.equals(java.lang.Object) ??????????????????????????????????????????equals(Object) ??????????????????????????????????????????????????????

??????????????????????????????????????? (documented classes)
javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? javadoc ???????????????????????????????????????????????? (public???protected???package-private ????????? private) ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????

??????????????? (included classes)
????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ????????????

??????????????? (excluded classes)
???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

??????????????? (referenced classes)
?????????????????????????????????????????????????????????????????????????????? (??????) ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????@see???{@link}???{@linkplain}???{@inheritDoc} ????????????????????????????????????????????? 1.3 ?????????????????????????????????javadoc ????????????????????????????????????Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????.class ??????????????????????????????????????????????????????

????????????????????? (external referenced classes)
???????????????????????????javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????java.awt ????????????????????????????????? Javadoc ?????????????????????????????????Object ????????? java.lang ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-link ????????? -linkoffline ?????????????????????????????????????????????????????????????????????????????????????????????????????? javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

?????????????????????

Javadoc ???????????????4 ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? Java ??????????????????????????? (.java)???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????

????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? .java ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

????????????????????????????????????????????????????????????????????????????????????????????????????????? 2 ?????????????????????????????????????????????????????????

????????????????????????????????? package.html ???????????????????????? package-info.java ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? .java ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

package-info.java - ????????????????????????????????????????????????????????????????????????????????????????????? ???????????????????????????????????????????????????????????????

File:java/applet/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 - ????????????????????????????????????????????????????????????????????????????????????????????? ??????????????? <body> ??????????????????????????????

File: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>

??????????????????????????? HTML ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? HTML ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? /** ??? */??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????<body> ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? @see ????????????????????????????????????????????????????????????????????????????????????????????????????????? package.html ????????????????????????????????????

???????????????????????????????????????????????? - Javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

??????????????????????????????

?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????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 ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? Java ????????? (.java) ?????????????????? (.class) ????????????????????????????????? Java ?????????????????????????????????????????????????????????????????????????????????????????????????????? HTML ????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????? doc-files ????????????????????????????????????????????? ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 1 ???????????????????????????????????????????????????????????????????????????????????????.class ?????????????????????????????????????????? HTML ?????????????????????????????????????????????????????????????????????????????????????????????????????? button.gif ??? java.awt.Button ??????????????????????????????????????????????????????????????????????????? /home/user/src/java/awt/doc-files/ ????????????????????????????????????doc-files ????????????????????? /home/user/src/java/doc-files ???????????????????????????????????? ????????????java ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ????????????Javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Button.java ????????????????????????????????????????????????????????????????????????????????????????????????

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

????????????????????????????????????????????????????????????

??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

????????????????????????????????????????????????????????? Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ????????????????????????????????????????????????.java???????????????????????????????????????

????????????????????? - ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (?????????????????????????????????????????? package ?????????????????????????????????????????????????????????????????? package ??????????????????????????????)????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????com.package1 ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

    com/package1/test-files/

??????????????????Javadoc ?????????????????????????????? test ?????????????????????????????????????????????

???????????????????????? doc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ?????????????????????????????????????????????????????????????????? ???????????????com/package1/test-files/*.java ???????????????

?????????????????????????????????????????? - ?????????????????????????????????????????????.java???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (Buffer-Template.java ??????) ???????????????????????? Java ??????????????????????????? ??????????????????????????????????????????????????????????????????????????????Javadoc ????????????????????????????????????.java????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????? (?????????????????????)???

???????????????????????????

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

?????????????????????

?????????????????????

????????????????????????

HTML ????????????

Javadoc ?????????????????????????????????????????????2 ??? 3 ?????? HTML ?????????????????????????????????1 ??????????????????????????????????????? (???????????????????????????????????????) ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (*.java) ?????????????????????????????????????????????????????? javadoc ????????????????????????????????????????????????????????????????????????????????????????????? (C) 1 ?????????????????????????????????Javadoc ????????????????????????????????????????????????????????????????????? (Detail) ?????????????????????????????????????????????????????????????????? 3 ??????????????? (P) ?????????????????????????????????????????????????????????????????????overview-summary.html ???????????????????????????????????????????????????2 ??????????????????????????????????????????????????????????????????????????????[??????????????????] ????????????????????????????????????overview-summary.html ??????????????????????????????????????????????????????????????????

HTML ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????[??????] ???????????????????????????????????????????????????????????????????????????????????????

              ------------                  ------------
              |C| Detail |                  |P| Detail |
              | |        |                  | |        |
              | |        |                  |-|        |
              | |        |                  |C|        |
              | |        |                  | |        |
              | |        |                  | |        |
              ------------                  ------------
             javadoc *.java           javadoc java.lang java.awt

HTML ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

????????????????????????????????????

????????????????????????????????????????????????????????????????????????????????????Java ????????????????????????????????????????????????????????????????????????????????????????????????????????????1 ???????????????????????????????????? 1 ????????????????????????????????????????????????????????????

???????????????java.applet.Applet ????????????????????????????????????????????????????????????java/applet/Applet.html ?????????????????????????????????????????????????????????????????? apidocs ??????????????????java.applet ???????????????????????????????????????????????????????????????????????????????????????????????????frame??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? HTML ????????????????????????????????????????????????????????????????????????

??? - ???????????????????????????????????????????????? (bold) ????????????????????????????????????????????? (*) ??????javadoc ????????????????????????????????????????????????????????????????????? (*.java) ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????package-list ????????????????????????????????????????????????doc-files ???????????????????????????????????????????????????????????????????????????????????????????????????????????????


apidocs                             ???????????????????????????
   index.html                       HTML ??????????????????????????????????????????
 * overview-summary.html            ????????????????????????????????? ???????????????????????????
   overview-tree.html               ????????????????????????????????????????????????
   deprecated-list.html             ??????????????????????????????????????? API ????????????
   constant-values.html             ????????????????????? static ?????????????????????????????????
   serialized-form.html             ?????????????????????????????????????????????????????????
 * overview-frame.html              ????????????????????????????????? ???????????????????????????????????????
   allclasses-frame.html            ???????????????????????????????????????????????? ???????????????????????????????????????
   help-doc.html                    ???????????????????????????????????????????????????????????????????????????
   index-all.html                   -splitindex ????????????????????????????????????????????????????????????
   index-files                      -splitindex ???????????????????????????????????????????????????????????????
       index-<number>.html          -splitindex ???????????????????????????????????????????????????????????????
   package-list                     ????????????????????????????????? ?????????????????????????????????????????????????????????
   stylesheet.css                   ?????????????????????????????????????????? HTML ?????????????????????
   java                             ?????????????????????????????????
       applet                       ???????????????????????????????????????
            Applet.html             Applet ?????????????????????
            AppletContext.html      AppletContext ?????????????????????????????????
            AppletStub.html         AppletStub ?????????????????????????????????
            AudioClip.html          AudioClip ?????????????????????????????????
          * package-summary.html    ???????????????????????????????????????????????? ???????????????????????????
          * package-frame.html      ???????????????????????????????????????????????? ???????????????????????????????????????
          * package-tree.html       ???????????????????????????????????????????????????
            package-use             ???????????????????????????????????????????????????????????????
            doc-files               ??????????????????????????????????????????????????????????????????????????????
            class-use               API ???????????????????????????????????????????????????????????????????????????
                Applet.html         Applet ?????????????????????????????????
                AppletContext.html  AppletContext ?????????????????????????????????????????????
                AppletStub.html     AppletStub ?????????????????????????????????????????????
                AudioClip.html      AudioClip ?????????????????????????????????????????????
   src-html                         ????????????????????????????????????
       java                         ?????????????????????????????????
           applet                   ???????????????????????????????????????
                Applet.html         Applet ??????????????????????????????
                AppletContext.html  AppletContext ??????????????????????????????
                AppletStub.html     AppletStub ??????????????????????????????
                AudioClip.html      AudioClip ??????????????????????????????

??????????????? API ??????

Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? API ????????????????????????????????? ???????????????????????? 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 ???????????????????????????????????????????????????????????? 2 ?????????????????????????????????????????????????????????????????????API ?????????????????????????????????

API ???????????????????????????????????????????????????????????????????????? synchronized ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????1 ?????? Enumeration ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Hashtable ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????

??????????????????????????????????????????

?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

?????????????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ("doc comments") ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ??????????????????????????????????????? (????????????????????????????????????????????????)????????????????????????????????????????????????????????????????????????????????????????????? /** ???????????????????????????????????????????????? */ ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 

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

????????????????????? 1 ????????????????????????????????????????????????????????????

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

????????????????????? - ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????javadoc ??????????????????1 ???????????????????????? 1 ??????????????????????????????????????????????????????????????????????????????

????????????????????????????????????????????????????????????????????????????????? import ?????????????????????????????????????????????????????????????????????????????????????????? ????????????????????????????????????????????????????????????

   /**
    * This is the class comment for the class Whatever.
    */

    import com.sun;   // MISTAKE - Important not to put import statement here

    public class Whatever {
    }

???????????????????????????????????????????????????????????????????????????????????????????????? - ????????????????????????????????????????????? /** ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? @ ?????????????????????????????????????????????????????????????????????????????? (???????????????????????????????????????????????????????????????????????????????????? /** ?????????)???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ????????????????????????????????????1 ????????????????????????????????????????????????????????????????????? @see ????????????????????????????????????????????????

/**
 * This sentence would hold the main description for this doc comment.
 * @see java.lang.Object
 */

?????????????????????????????????????????? - ??????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????@tag ?????????????????????????????????????????? (???????????????????????????????????????????????????) ??????????????????????????? ({@tag} ???????????????????????????????????????) ??? 2 ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (/**) ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? @ ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? @ ?????????????????????????????????????????????????????????????????????????????????HTML ???????????????????????????@?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (?????????????????????????????????????????????) ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? @deprecated ??????????????????????????? {@link} ??????????????????????????? 

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

??????????????? HTML ??????????????? - ??????????????? HTML ???????????????????????????????????????????????? ????????????HTML ?????????????????????????????????????????????????????????????????? HTML ??????????????????????????????????????????????????????????????? HTML ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????????????? (CSS) ????????????????????????????????????????????? (?????????????????????????????????????????????????????????) ??? HTML 3.2 ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????HTML 4.0???????????????????????????

?????????????????????????????? (<) ???????????????????????? (>) ??????????????????< ????????? > ??????????????????????????????????????????????????????????????????????????? (&) ??????& ???????????????????????????????????????????????????????????????????????? HTML ?????? <b> ????????????????????????

?????????????????????????????????????????????????????????????????????

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

??????????????????????????? - Javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (*) ?????????????????????????????? ???????????????????????????????????? (*) ??????????????????????????????????????????????????????????????? 1.4 ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? <PRE> ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? /** ????????? <PRE> ??????????????????????????????????????????

???????????? - ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (???????????????????????????????????????????????????)?????????????????????????????????????????????????????????????????????????????????Javadoc ????????????????????? HTML ????????????????????????????????????????????????????????????????????????????????????

?????????????????????????????? - Java ?????????1 ???????????????????????????????????????????????????????????? ??????????????????????????????1 ?????????????????????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????1 ?????????????????????????????????????????????????????? ??????????????????????????? 2 ?????????????????????????????????????????????

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

???????????????????????????????????????????????????????????????????????????????????????

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 ???????????????????????? 2 ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? -sourcepath ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 1.3.x ??????????????????????????????????????????

?????????????????????????????????????????????????????? - ??????????????????????????????????????????????????????????????? 3 ????????????????????????????????????????????????????????????

????????? 2 ??????????????? (??????????????????????????????????????????????????????) ?????????Javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

3 ?????????????????? (???????????????????????????????????????????????????????????????????????????????????????????????????) ?????????javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

????????????????????????????????????????????????????????? - ???????????????????????????????????????????????????????????????????????????????????????????????????????????? {@inheritDoc} ????????????????????????Javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????? ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

  1. ?????????????????????????????? (?????????????????????????????????) ??????????????????????????????????????????????????? implements (????????? extends) ???????????????????????????????????????????????????1 ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
  2. ?????? 1 ??????????????????????????????????????????????????????????????????????????????????????????????????????????????? (?????????????????????????????????) ???????????????????????????????????????????????????????????????????????????????????????????????????????????? (?????????????????????????????? 1 ????????????????????????????????????????????????????????????)
  3. ?????? 2 ?????????????????????????????????????????????????????????????????????????????????????????????????????? Object ??????????????????????????? (?????????????????????????????????) ???????????????????????????????????????
    1. ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
    2. ?????? 3a ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

javadoc ??????

Javadoc ???????????????Java ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? API ?????????????????????????????????????????????????????????????????????????????????????????????????????? (@) ???????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (???????????????????????????????????????????????????????????????) ????????????????????????????????????????????????????????????????????????????????? 1 ?????????????????????????????????????????????????????????????????????@see ????????????????????????????????????????????? 1 ???????????????????????????????????????

???????????? 2 ?????????????????????????????????

??????????????????????????????????????????????????????????????????Proposed Javadoc Tags?????????????????????????????????

?????????????????????????????????????????????????????????

?????? ??????????????? JDK/SDK ??????????????????
@author 1.0
{@code} 1.5
{@docRoot} 1.3
@deprecated 1.0
@exception 1.0
{@inheritDoc} 1.4
{@link} 1.2
{@linkplain} 1.4
{@literal} 1.5
@param 1.0
@return 1.0
@see 1.0
@serial 1.2
@serialData 1.2
@serialField 1.2
@since 1.1
@throws 1.2
{@value} 1.4
@version 1.0

????????????????????????????????????-tag ?????????????????????????????????????????????

@author  name-text
-author ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? name-text ????????????????????????1 ???????????????????????????????????????????????????????????? @author ??????????????????????????????????????????1 ?????? @author ????????? 1 ???????????????????????????????????????1 ??????????????????????????????????????????????????????????????????????????????????????????Javadoc ????????????????????????????????????????????????????????? (,) ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????1 ????????????????????????????????????????????????????????????

????????????????????????????????????????????????????????????????????? @author ?????????????????????????????????????????????????????????

@deprecated  deprecated-text

???: JDK 5.0 ?????????@Deprecated ???????????????????????????????????????????????????????????????????????????????????????????????????

?????? API ???????????????????????????????????? API ?????????????????????????????????????????????????????????????????????????????????Javadoc ???????????????deprecated-text ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

deprecated-text ???????????????????????????????????????????????? API ?????????????????????????????????????????????????????????????????? API ????????????????????????????????????????????????Javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? API ??????????????????????????????????????????????????????????????????????????????????????? API ??????????????? {@link} ?????? (Javadoc 1.2 ???????????????) ???????????????????????????????????? ?????????????????????????????????

????????????????????????@deprecated ?????????????????????????????????????????????????????????

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

???????????????????????????????????????????????????@deprecated ?????????????????????????????????????????????????????????

{@code  text}
<code>{@literal}</code> ??????????????????

??????????????? HTML ???????????????????????????????????????????????? javadoc ?????????????????????????????????text ??? code ???????????????????????????????????????????????? doc ????????????????????????????????????????????? (<Object>)???????????? (3 < 4)?????????????????? (<-) ????????????HTML ????????????????????? (< ????????? >) ????????????????????????????????? (< ????????? >) ???????????????????????????????????? doc ???????????????????????????

     {@code A<B>C}

????????????????????? HTML ??????????????????????????????????????????????????????????????? 

     A<B>C

??????????????????????????????<B> ???????????????????????????????????????????????????????????????????????????????????????

??????????????????????????????????????????????????????????????????{@literal} ?????????????????????

{@docRoot}
?????????????????????????????????????????????????????????????????? (????????????) ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

?????? {@docRoot} ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????@return???@param???@deprecated ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

  1. ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 
       javadoc -bottom '<a href="{@docRoot}/copyright.html">Copyright</a>'

    - {@docRoot} ???????????????????????????????????????????????? Makefile ????????????????????????????????? { } ?????????????????????????????????????????????????????????????????????Inprise MAKE ??????????????? 5.2 ??? Windows ?????????????????????????????????{{@docRoot}}?????????????????????????????????????????????????????????????????????????????????-bottom ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? href ???????????????????????????????????????????????????

  2. ?????????????????????????????????????????????????????????????????????????????????????????? 
       /**
    * See the <a href="{@docRoot}/copyright.html">Copyright</a>.
    */

???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 

  <a href="{@docRoot}/copyright.html">

???????????????????????????????????? 

  <a href="../../copyright.html">      java/lang/Object.java ?????????

????????? 

  <a href="../../../copyright.html">   java/lang/ref/Reference.java ?????????

@exception  class-name  description
@exception ????????????@throws ????????????????????????

{@inheritDoc} 
??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (?????????) ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????????????????????

????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

{@link   package.class#member   label} 
?????????????????? label ??????????????????????????????????????????????????? label ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????@return???@param???@deprecated ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

??????????????????@see ????????????????????????????????? ????????????????????????package.class#member ????????? label ???????????????????????????????????????????????????????????????????????????????????????????????????{@link} ?????????????????? [????????????] ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????{@link} ??????????????????????????????????????????????????????????????????????????????}???????????????????????????????????????HTML ???????????????????????????}?????????????????????

1 ????????????????????????????????? {@link} ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? @deprecated???@return???@param ??????????????????????????????????????????????????????????????????????????????

??????????????????????????????????????? getComponentAt(int, int) ???????????????????????????????????????

{@link #getComponentAt(int, int) getComponentAt} ?????????????????????????????????

?????????????????????????????????????????????????????????????????? HTML ????????????????????? (???????????????????????????????????????????????????????????????????????????????????????)??? 

<a href="Component.html#getComponentAt(int, int)">getComponentAt</a> ?????????????????????????????????

?????? HTML ??????Web ?????????????????????????????????????????????????????? 

getComponentAt ?????????????????????????????????

{@link} ?????????????????????????????????????????????????????????????????????????????????????????????-link ????????????????????????????????????

????????????????????????{@link} ?????????????????????????????????????????????????????????

{@linkplain  package.class#member  label}
??????????????????????????????????????????????????????????????????????????????????????????????????????????????? {@link} ???????????????????????????????????????????????????????????????????????????????????????????????????: 
     {@linkplain add() the overridden method} ??????????????????????????????

????????????????????????????????????????????????

the overridden method ??????????????????????????????

{@literal  text}
??????????????? HTML ???????????????????????????????????????????????? javadoc ?????????????????????????????????text ???????????????????????????????????? doc ????????????????????????????????????????????? (<Object>)???????????? (3 < 4)?????????????????? (<-) ????????????HTML ????????????????????? (< ????????? >) ????????????????????????????????? (< ????????? >) ???????????????????????????????????? doc ??????????????????????????? 
     {@literal A<B>C}

????????????????????? HTML ???????????????????????????????????????????????????????????????????????????

     A<B>C

??????????????????????????????<B> ?????????????????????????????????????????? (????????????????????????????????????)???

????????????????????????????????????????????????????????????{@code} ?????????????????????

@param  parameter-name description
???????????? parameter-name ??????????????? description ????????????????????????????????????Parameters???????????????????????????????????????doc ???????????????????????????????????????description ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? doc ???????????????????????????????????????

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) {
     }

????????????????????????@param ?????????????????????????????????????????????????????????

@return  description
[?????????] ?????????????????????????????????description ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

????????????????????????@return ?????????????????????????????????????????????????????????

@see   reference
[????????????] ????????????????????????reference ?????????????????????????????????????????????????????????????????????????????????1 ???????????????????????????????????????????????????????????????????????? @see ?????????????????????????????? ???????????? @see ??????????????????????????????????????????????????????????????????????????????@see ????????????????????? 3 ????????????????????????????????? ???????????????????????????????????????3 ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????{@link} ??????????????????????????????
@see "string"
string ????????????????????????????????????????????????????????????????????????????????????string ????????????????????? URL ?????????????????????????????????????????????????????????Javadoc ???????????????????????????????????????????????? (") ??????????????????????????????????????????????????? 2 ?????????????????????????????????????????????????????? 
     @see "The Java Programming Language"

?????????????????????????????????????????????????????????

????????????:
The Java Programming Language
@see <a href="URL#value">label</a>
URL#value ????????????????????????????????????????????????????????????URL#value ???????????? URL ??????????????? URL ?????????Javadoc ???????????????????????????????????????????????????????????? (<) ??????????????????????????????????????????????????? 2 ?????????????????????????????????????????????????????? 
     @see <a href="spec.html#section">Java Spec</a>

??????????????????????????????????????????????????????

????????????:
Java Spec

@see  package.class#member  label
?????????????????????????????????????????????????????? Java ???????????????????????????????????????????????????????????????????????????????????????????????? label ??????????????????????????????label ???????????????????????? label ????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????-noqualifier ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

??????????????? 1.2 ????????????????????????????????????????????? <code> HTML ????????????????????????????????????????????? 1.2.2 ???????????????????????????????????????????????????????????????????????????<code> ?????????????????????????????????????????????????????????????????????

  • package.class#member ??????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ???????????????????????????????????????????????????????????????????????? (#) ????????????????????????class ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????member ??????????????????????????????????????????????????????????????????????????? (????????????????????????????????????????????????????????????????????????) ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-link ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 2 ??????????????? @see ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
  • label ??????????????????????????????????????????????????????????????????????????????????????????label ????????????????????????????????????????????????label ?????????????????????package.class.member ????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????
  • ??????????????????package.class#member ??? label ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

??? - ??????????????????Character ?????????????????? @see ????????????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 ????????????????????????????????????????????????????????????????????????

@see package.class#member ?????????????????????
????????????????????????????????????????????????
@see #field
@see #method(Type, Type,...)
@see #method(Type argname, Type argname,...)
@see #constructor(Type, Type,...)
@see #constructor(Type argname, Type argname,...)
?????????????????????????????????????????????????????????????????????????????????????????????
@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
????????????????????????????????????????????? (????????????)
@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

?????????????????????????????????????????????????????????

@see ??????????????? - Javadoc ???????????????????????????????????? (.java)?????????????????????????????? (package.html ????????? package-info.java)?????????????????????????????? (overview.html) ????????????????????? @see ???????????????????????????????????? 2 ??????????????????????????????????????????????????? @see ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

Javadoc ???????????????.java ??????????????????????????????????????????????????????????????? @see ???????????????????????????Java ??????????????????????????????????????????????????????????????????????????? ????????????Javadoc ?????????????????????????????????????????????????????????????????????????????? ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Java ??????????????? 2 ????????? 6 ??????Names??????????????????????????????????????????Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

  1. ????????????????????????????????????????????????
  2. ????????????????????????????????????????????????????????? (????????????????????????????????????)
  3. ????????????????????????????????????????????????????????? (????????????????????????????????????)
  4. ????????????????????????
  5. ?????????????????????????????????????????????????????????????????????????????????????????? (import ??????????????????????????????)

Javadoc ????????????????????????????????????????????? 1 ??? 3 ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? E ??????????????????????????? E ???????????????????????????????????????????????????????????? E ?????????????????????????????????????????????????????? 4 ??? 5 ?????????1 ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????? 5 ?????????Javadoc ???????????????java.lang ????????????????????? ????????????????????????????????????????????????????????????????????????????????????????????????????????????

Javadoc ????????????????????????????????????????????????????????????????????????????????? ?????????javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????@see ????????? java.awt.event.KeyEvent ???????????????????????????java.awt ????????????????????????????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????

?????????????????????????????? - label ?????????????????????package.class.member ????????????????????????????????????package.class.member ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????String.toUpperCase() ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (??????????????????)???

??????????????????????????????????????????????????????-noqualifier ?????????????????????

??????????????? String.toUpperCase() ????????? ?????????????????????
@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 ??????) ??????????????????????????????????????????????????????????????????????????????????????????????????????

                                           ????????????: 
@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 ????????????????????????????????????

????????????????????????@see ?????????????????????????????????????????????????????????

@serial  field-description | include | exclude
??????????????????????????????????????????????????????????????????????????????????????????????????????????????????

field-description (????????????) ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

include ????????? exclude ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???: javax.swing ?????????????????????@serial exclude ??????????????????????????? (package.html ????????? package-info.java ???)???public ????????? java.security.BasicPermission ??????@serial exclude ??????????????????????????????package private ????????? java.util.PropertyPermissionCollection ??????@serial include ??????????????????????????????

???????????????????????????????????? @serial ?????????????????????????????????????????????????????? @serial ??????????????????????????????????????????

????????????????????????????????????????????????????????????????????????Java ?????????????????????????????????????????? 1.6 ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? FAQ????????????????????????????????? ?????? FAQ ????????????-private ????????????????????????????????? javadoc ??????????????????????????? private ?????????????????? @serial ???????????????????????????????????? javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Sun ??????????????????????????????????????????

@serialField  field-name  field-type  field-description
Serializable ???????????? serialPersistentFields ??????????????? ObjectStreamField ???????????????????????????????????????????????????????????? ObjectStreamField ????????????????????????????????? @serialField ????????? 1 ?????????????????????????????????

@serialData  data-description
data-description ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????writeObject ?????????????????????????????????????????????????????????????????????????????? Externalizable.writeExternal ??????????????????????????????????????????????????????????????? (????????????????????????) ?????????????????????

@serialData ????????????writeObject???readObject???writeExternal???readExternal???writeReplace???????????? readResolve ?????????????????????????????????????????????????????????????????????????????????

@since  since-text
??????????????????????????? [??????????????????????????????] ??????????????????????????????????????? since-text ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????since-text ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 
    @since 1.5

Java ???????????????????????????????????????????????????????????????????????????Java ???????????????????????? API ?????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? @since ????????????????????????????????? @author ????????????????????????????????????????????????????????????????????? API ??????????????????????????????????????????????????????????????????

@throws  class-name  description 
@throws ????????? @exception ??????????????????????????????????????????????????? [??????] ??????????????????????????????class-name ??? description ????????????????????????????????????class-name ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? doc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????? doc ??????????????????????????? @throws ??????????????????????????????

????????????????????????????????????????????????????????????????????????????????????????????????@throws ????????? throws ????????????????????????????????????????????????@throws ????????????????????????????????????????????????????????????Javadoc ?????????????????????????????? HTML ?????????????????????????????????????????????????????????

?????????????????????????????????????????????????????????????????????????????????????????????????????????@throws ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????@throws ????????????????????????????????????????????????????????????{@inheritDoc} ????????????????????????

????????????????????????@throws ?????????????????????????????????????????????????????????

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

????????? doc ???????????????????????? package.class#field ?????????????????????????????????????????????????????????????????????????????????????????? 

    /**
     * Evaluates the script starting with {@value #SCRIPT_START}.
     */
    public String evalScript(String script) {
    }

?????? package.class#field ??????@see ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

?????????????????????????????????????????????????????????????????????????????????????????????

@version  version-text
-version ???????????????????????????????????????????????????????????????????????? [???????????????] ????????????????????????????????????????????? version-text ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????@since ?????????????????????????????????????????????????????????????????????????????????version-text ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

1 ???????????????????????????????????????????????????????????? @version ???????????????????????????????????????????????????????????????@version ??????????????? 1 ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ????????????????????????????????????????????????????????? (,) ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????1 ????????????????????????????????????????????????????????????

????????????????????????@version ?????????????????????????????????????????????????????????

??????????????????????????????

???????????????????????????????????????????????????????????????????????????@see???@since???@deprecated???{@link}???{@linkplain} ????????? {@docroot} ??????????????????????????? doc ????????????????????????????????????

?????????????????????????????????????????????

??????????????????????????????????????????????????????????????????????????????????????????????????????????????? ???????????????????????????????????????????????????????????? overview.html ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

??? - ??????????????? 1.2 ??????????????????????????????????????? {@link} ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????{@docRoot} ??????????????????????????????????????????????????????????????????

????????????
@see
@since
@author
@version
{@link}
{@linkplain}
{@docRoot}

???????????????????????????????????????????????????

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

?????????????????????
@see
@since
@serial
@author
@version
{@link}
{@linkplain}
{@docRoot}

???????????????????????????????????????????????????????????????????????????

??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? @serial ????????????include ????????? exclude ??????????????????????????????????????????

?????????????????????????????????????????????
@see
@since
@deprecated
@serial
@author
@version
{@link}
{@linkplain}
{@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
@since
@deprecated
@serial
@serialField
{@link}
{@linkplain}
{@docRoot}
{@value}

?????????????????????????????????????????????????????????

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

??????????????????????????????????????????????????????????????????????????????

????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ????????????@return ????????????????????????????????????????????????{@inheritDoc} ????????????????????????????????????@serialData ?????????????????????????????????????????? doc ??????????????????????????????????????????

????????????????????????????????????????????????
@see
@since
@deprecated
@param
@return
@throws ??? @exception
@serialData
{@link}
{@linkplain}
{@inheritDoc}
{@docRoot}

???????????????????????????????????????????????????????????????????????????????????????

    /**
     * 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 ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????

-1.1
-author
-bootclasspath
-bottom
-breakiterator
-charset
-classpath
-d
-docencoding
-docfilessubdirs
-doclet
-docletpath
-doctitle
-encoding
-exclude
-excludedocfilessubdir
-extdirs
-footer
-group
 -header
-help
-helpfile
-J
-keywords
-link
-linkoffline
-linksource
-locale
-nocomment
-nodeprecated
-nodeprecatedlist
-nohelp
-noindex
-nonavbar
-noqualifier
-nosince
-notimestamp
-notree
-overview
-package
 -private
-protected
-public
-quiet
-serialwarn
-source
-sourcepath
-splitindex
-stylesheetfile
-subpackages
-tag
-taglet
-tagletpath
-title
-use
-verbose
-version
-windowtitle

???????????????????????????????????????????????????Javadoc ????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

Javadoc ???????????????

-overview  path/filename
Javadoc ???????????????path/filename ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (overview-summary.html) ??????????????????????????????????????????path/filename ??????-sourcepath ???????????????????????????

filename ??? path ????????????????????????????????????????????????????????????????????????????????????overview.html ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-sourcepath ??????????????????????????????????????????????????????????????????????????????????????????????????????????????? path ??????????????????????????????????????????java.lang ??????????????????????????????????????? /src/classes/java/lang/ ????????????????????????????????? /src/classes/overview.html ?????????????????????????????????????????????????????????????????????

path/filename ???????????????????????????????????????????????????????????????????????????????????????????????????????????????

??????????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????HTML ?????????????????????????????????????????????

????????????????????????????????????-doctitle ?????????????????????????????????

-public
public ?????????????????????????????????????????????????????????

-protected
protected ????????? public ????????????????????????????????????????????????????????????????????????????????????????????????

-package
package???protected???????????? public ??????????????????????????????????????????????????????

-private
?????????????????????????????????????????????????????????

-help
????????????????????????????????????????????? Javadoc ????????????????????????????????????????????????????????????????????????????????????

-doclet  class
???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-doclet ????????????????????????????????????????????????Javadoc ???????????????????????????????????????????????????????????? HTML ???????????????????????????????????????????????????start(Root) ???????????????????????????????????????????????????????????????????????????????????????????????????-docletpath ????????????????????????????????????????????????

???????????????MIF ???????????????????????????????????????????????????????????????????????????

    -doclet com.sun.tools.doclets.mif.MIFDoclet

????????????????????????????????????????????????????????????????????????MIF Doclet ???????????????????????????????????????????????????

-docletpath  classpathlist
-doclet ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? jar ??????????????????????????????????????????????????????????????????????????? jar ????????????????????????????????????????????????????????? jar ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????classpathlist ????????????????????????????????? JAR ???????????????????????????????????????????????? ????????????????????????????????? JAR ??????????????????Solaris ???????????????????????? (:)???Windows ?????????????????????????????? (;) ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

jar ???????????????????????????????????????????????????????????????????????????????????????????????????????????????jar ?????????????????????????????????????????????????????????????????????

   -docletpath /home/user/mifdoclet/lib/mifdoclet.jar
???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 
   -docletpath /home/user/mifdoclet/classes/com/sun/tools/doclets/mif/
????????????????????????????????????????????????????????????????????????MIF Doclet ???????????????????????????????????????????????????

-1.1
??????????????????Javadoc 1.4 ??????????????????????????????????????????????????????????????????????????????????????????Javadoc 1.1 ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc 1.2 ????????? 1.3 ??????????????????????????????

-source release
????????????????????????????????????????????????????????????????????????release ???????????????????????????????????????
1.5 Javadoc ??????JDK 1.5 ????????????????????????????????????????????????????????????????????????????????????????????????-source ??????????????????????????????????????????????????????????????????????????? 1.5 ????????????????????????
1.4 Javadoc ??????JDK 1.4 ?????????????????????????????????????????????????????????????????????????????????
1.3 Javadoc ??????JDK 1.3 ???????????????????????????????????????????????????????????????????????????????????????????????????????????????

javac ??????????????????????????????????????????????????????????????????????????? release ???????????????????????????

-sourcepath  sourcepathlist
javadoc ?????????????????????????????????????????? -subpackages ?????????????????????????????????????????? (.java) ???????????????????????????????????????????????????sourcepathlist ?????????????????? (:) ??????????????????????????????????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-sourcepath ?????????????????????javadoc ?????????????????????????????????????????????????????????????????????????????? javadoc ??????????????????????????? .java ???????????????????????????????????????????????????????????????.java ???????????????????????????????????????????????????????????????????????????????????? cd ??????????????????????????????????????????????????????????????????????????????????????? (???1 ?????????????????????????????????????????????????????????)???-sourcepath ???????????????????????????Javadoc ???????????????????????????????????????????????????????????????????????? (-classpath ?????????)??????????????????????????????????????? -sourcepath ????????????????????????????????????-classpath ???????????????????????????????????? Javadoc ???????????????Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

sourcepathlist ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????com.mypackage ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

  /home/user/src/com/mypackage/*.java
???????????????????????????????????? sourcepath ??? /home/user/src???????????? com/mypackage ???????????????????????????????????????????????????????????????????????? com.mypackage ????????????????????? 
  % javadoc -sourcepath /home/user/src/ com.mypackage
?????????????????????????????????????????????????????????????????????????????????????????? (?????????) ???\??????????????????????????????????????????????????? (C:\user\src\com\mypackage) ????????????????????????????????????????????????/home/user/src/com/mypackage.

2 ????????????????????????????????????????????????????????????????????????

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

-classpath  classpathlist
Javadoc ?????????????????? (.class ????????????) ?????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????classpathlist ?????????????????? (:) ??????????????????????????????????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????classpathlist ?????????????????????????????????????????????????????????????????????????????????????????????????????????

-sourcepath ?????????????????????????????????Javadoc ???????????????-classpath ?????????????????????????????????????????????????????????????????????????????????????????? (????????????????????????)?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-sourcepath ??? -classpath ???????????????????????????

???????????????com.mypackage ???????????????????????????????????????????????????????????????????????????????????? /home/user/src/com/mypackage ???????????????????????????????????? /home/user/lib ?????????????????????????????????????????????????????????????????????????????????

  % javadoc -classpath /home/user/lib -sourcepath /home/user/src com.mypackage
?????????????????????????????????-classpath ???????????????????????????????????????CLASSPATH ??????????????????????????????????????????Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????Javadoc ???????????????????????????????????????????????????????????????????????????

Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ???????????? -classpath ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

????????????* ???????????????????????????????????????????????????????????????????????????????????? .jar ????????? .JAR ????????????????????????????????????????????????????????????????????????????????????????????? (Java ???????????????????????? 2 ???????????????????????????????????????)???

????????????????????????????????? foo ??? a.jar ??? b.JAR ??????????????????????????????????????????????????? foo/* ??? A.jar:b.JAR ???????????????????????? ????????????JAR ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? JAR ?????????????????????????????????* ??????????????????????????????????????????????????????????????????????????????????????????????????? JAR ????????????????????????????????????????????????CLASSPATH ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Java ?????????????????????????????????????????????????????????????????????System.getenv("CLASSPATH") ????????????????????????????????????????????????????????????????????????Java ?????????????????????????????????????????????????????????????????????????????????????????????????????????

-subpackages  package1:package2:...
???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? package ??????????????????????????????????????????????????? (java ??????) ??????????????????????????????????????? (javax.swing ??????) ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (????????????????????????????????????????????????)??????????????????????????????????????? (????????????)?????????????????????????????????????????????????????????-sourcepath ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

?????????????????????

  % javadoc -d docs -sourcepath /home/user/src -subpackages java:javax.swing
???????????????????????????java???????????????javax.swing????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-exclude ???????????? -subpackages ?????????????????????????????????????????????????????????????????????

-exclude  packagename1:packagename2:...
??????????????????????????????????????????????????????????????? -subpackages ????????????????????????????????????????????????????????????????????????????????? -subpackages ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 
  % javadoc -sourcepath /home/user/src -subpackages java -exclude java.net:java.lang
???????????????java.io???java.util???java.math ??????????????????????????????java.net ??? java.lang ????????????????????????????????????????????????????????????java.lang ????????????????????????????????? java.lang.ref ????????????????????????

-bootclasspath  classpathlist
????????????????????????????????????????????????????????????????????????????????????????????????Java ??????????????????????????????????????????????????????????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????javac ??? javadoc ??????????????????????????????????????????????????????????????????classpathlist ???????????????????????????????????????????????? (:) ?????????????????????

-extdirs  dirlist
?????????????????????????????????????????????????????????????????????????????????????????????????????????Java ?????????????????????????????????????????????????????????extdirs ??????Javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? -classpath ??????????????????????????????dirlist ???????????????????????????????????????????????? (:) ?????????????????????

-verbose
javadoc ????????????????????????????????????????????????????????????verbose ???????????????????????????????????????????????????????????????????????????????????????????????????????????? (?????????????????????????????? 1 ?????????????????????)??????????????????????????????????????????????????????????????????verbose ??????????????????????????????????????? Java ???????????????????????????????????????????????? (???????????????) ?????????????????????????????????????????????????????????

-quiet
????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-breakiterator 
???????????????????????????????????????????????????????????????????????????java.text.BreakIterator ??????????????????????????????????????????????????????????????????????????????????????????????????? (?????????????????????????????????????????? BreakIterator ?????????)?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

JDK 1.2 ?????????BreakIterator ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????1.2 ???????????????-breakiterator ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

  • ????????????????????????????????????????????????????????? - ??????????????? HTML ?????????????????? (<P> ??????) ????????????????????????????????????
  • breakiterator ?????????????????????????????? - ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (???The serial no. is valid???????????????????????????Mr. Smith????????????????????????)???HTML ????????????????????????????????????????????????????????????????????????HTML ???????????????????????????????????????????????????../filename??????????????????????????????????????????

???: 1.5.0 ????????????1.4.x ???????????????????????? breakiterator ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????\-breakiterator ?????????????????????1.5.0 ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????(1.5.0) ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????1.4.x ?????? breakiterator ?????????????????????????????????????????????1.5.0 ???????????????????????????????????????????????????????????????????????? ??????????????????????????????breakiterator ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-locale  language_country_variant

?????? - -locale ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (??????) ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

Javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????java.util.Locale ??????????????????????????????????????????????????????????????????????????????????????????????????????en_US (???????????????)???en_US_WIN (Windows ?????????????????????) ???????????????????????????

??????????????????????????????????????????????????????????????????????????????????????? Javadoc ????????????????????????????????????????????? (?????????????????????????????????????????????????????????????????????????????????????????????stylesheet.css ?????????????????????????????????) ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-encoding  name
????????????????????????????????????????????????????????? (EUCJIS/SJIS ??????) ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-docencoding ????????? -charset ??????????????????????????????

-Jflag
javadoc ???????????????????????????????????? java ??????flag ????????????????????????J ??? flag ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 32M ????????????????????????????????????????????????????????????????????????Java ??? -Xmx ?????????????????????????????????????????????????????? -Xms ??????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 
   % javadoc -J-Xmx32m -J-Xms32m com.mypackage
?????????????????? javadoc ????????????????????????????????????????????????????????? java ??????-version?????????????????????????????????????????? 
   % javadoc -J-version
   java version "1.2"
   Classic VM (build JDK-1.2-V, green threads, sunwjit)
????????????????????????????????????????????????????????????????????????????????????????????????

??????????????????????????????????????????????????????

-d  directory
??????????????? HTML ????????????????????????????????????????????????????????????????????????(???d?????????????????? (destination)????????????)????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? directory ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 1.4 ?????????javadoc ?????????????????????????????????????????????????????????????????????????????????

?????????????????????????????????com.mypackage ???????????????????????????????????????????????????????????? /home/user/doc/ ???????????????????????????????????????

  % javadoc -d /home/user/doc com.mypackage

-use
???????????????????????????????????????????????????????????????????????? 1 ?????? [??????] ???????????????????????????????????????????????????????????????????????????????????????????????????????????? API ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? C ?????????????????????????????? C ???????????????????????????????????????C ?????????????????????C ????????????????????????????????????????????????C ??????????????????????????????????????? C ?????????????????????????????????????????????????????????????????????????????????

???????????????String ??? [??????] ???????????????????????????????????????????????????????????????java.awt.Font ???????????? getName() ??????????????????String ???????????????????????????????????????getName() ??? String ???????????????????????????String ??? [??????] ???????????????????????????????????????????????????

???????????????????????????????????????????????? API ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? String ???????????????????????????????????????????????????????????????????????????????????????????????????????????????String ?????????????????????????????????????????????

??????????????? [??????] ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? [??????] ????????????????????????????????????

-version
??????????????????????????????@version ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? Javadoc ???????????????????????????????????????????????????-J-version ????????????????????????????????????

-author
??????????????????????????????@author ???????????????????????????????????????

-splitindex
?????????????????????????????????????????????????????????????????????????????????????????????????????? 1 ???????????????????????????????????????????????????????????????????????????????????????????????? 1 ???????????????????????????????????????

-windowtitle  title
HTML ??? <title> ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (???????????????) ???????????????????????????????????????????????? HTML ??????????????????????????????????????? ??????????????? HTML ??????????????????????????????????????????????????????????????????????????????????????????title ????????????????????????????????????????????????????????????????????????????????????????????????-windowtitle ?????????????????????????????????Javadoc ??????????????????????????????????????????????????? -doctitle ???????????????????????? 
  % javadoc -windowtitle "Java 2 Platform" com.mypackage
-doctitle  title
??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 1 ??????????????????????????????????????????????????????????????????????????????????????????title ?????????HTML ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????title ???????????????????????????????????????????????????????????????????????????????????????????????? 
  % javadoc -doctitle "Java<sup><font size=\"-2\">TM</font></sup>" com.mypackage
-title  title
?????????????????????????????????????????????????????????Javadoc 1.2 ????????????????????????????????????????????????????????????????????????-doctitle ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

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

-footer  footer
?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? footer ?????????HTML ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????footer ????????????????????????????????????????????????????????????????????????????????????????????????

-bottom  text
??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????text ?????????HTML ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????text ????????????????????????????????????????????????????????????????????????????????????????????????

-link  extdocURL
javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 1 ??????????????????

  • extdocURL ??????????????????????????????????????????javadoc ??????????????????????????????????????????????????????????????????????????????????????? URL ??????????????? URL ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ???????????????????????????-linkoffline ?????????????????????Javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? URL ????????????????????????Javadoc ????????????????????????????????????????????? <A HREF> ??????????????? extdocURL ???????????????????????????????????????????????????????????????extdocURL ????????????????????? URL ??????????????????????????????????????? URL????????????????????????????????????

    extdocURL ??????????????????????????????????????????????????????????????????????????????????????? Web ???????????????????????????????????????????????????????????? ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-d ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

    ???????????????????????????????????????????????????http:??????????????????????????????Web ?????????????????????????????????????????????????????????????????????????????????file: ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

    ?????????????????????????????????????????????????????????????????????????????????????????? URL ????????? URL ?????????http:??????????????????file:????????????????????????????????????????????????????????????????????????????????????????????? (URL Memo ?????????)???

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

javadoc ???????????????????????? -link ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-linkoffline ????????? -link ?????????
-link ?????????????????????:
  • ?????? API ?????????????????????????????????????????????????????????
  • ?????? API ?????????????????????????????? URL ????????????????????? (???????????????????????? URL ?????????????????????????????????????????????????????????????????????????????????????????????)
???????????????????????????-linkoffline ????????????????????????????????????
  • ???????????????????????? URL ????????????????????????????????????????????????????????????????????????????????????????????????????????? API ?????????????????????????????? URL ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

????????????????????????????????????????????????????????? - http://java.sun.com/j2se/1.5.0/docs/api ?????? java.lang???java.io??????????????? Java 2 ???????????????????????????????????????????????????????????????????????????????????? ????????????????????????com.mypackage ??????????????????????????????????????? Java 2 ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? Object ???????????????????????????????????????????????????-sourcepath ??? -d ?????????????????????????????????????????????????????????

  % javadoc -link http://java.sun.com/j2se/1.5.0/docs/api com.mypackage
????????????????????????????????????????????????????????? - 2 ???????????????????????????????????????????????????????????? Javadoc ???????????????????????????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????2 ???????????????????????????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 ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????http://java.sun.com ????????? java.* ???????????????????????????????????????????????????????????????

?????????????????? Javadoc ??????????????????????????????????????????????????? API ??????????????????????????????????????????????????????-link ????????????????????????????????????-link ???????????????????????????????????????????????????Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? javadoc ?????????????????????????????????????????????????????????????????? javadoc ???????????????????????? 2 ???????????????????????????????????????????????????????????????????????????

???????????????????????? - ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????import ??????????????????????????????????????????????????????????????????????????? java.io.File ?????????????????????????????????????????????

  • ????????????????????? import ????????????: ?????????????????????????????????????????????????????????????????????????????????????????????????????? java.lang.* ????????????????????????????????????????????????????????????????????????????????????????????????
    import java.io.*;
    1.3.x ????????? 1.2.x ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? java.lang.* ???????????????????????????
  • ???????????????:
    void foo(File f) {}
    ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????implements???extends???????????? throws ?????????????????????

???????????????-link ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????? - -link ?????????????????????package-list ??????????????????????????????????????????????????? ????????????????????????Javadoc ????????????????????????????????????-link ???????????????????????? URL ?????????????????????package-list ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ??????????????????????????? URL ????????? package-list ??????????????????????????????????????????????????????????????????????????????????????? URL ???????????????????????????????????????????????????????????????????????????

???????????????Java ???????????????????????? v5.0 API ?????????????????????????????? http://java.sun.com/j2se/1.5.0/docs/api/package-list ????????????????????????????????????????????????????????????

  java.applet  
  java.awt
  java.awt.color
  java.awt.datatransfer
  java.awt.dnd
  java.awt.event
  java.awt.font
  ????????? ...

-link ????????????????????????????????? javadoc ????????????????????????????????????????????????????????????????????????????????????javadoc ???????????????????????????????????????????????????????????????????????????-link ?????????????????????????????????????????????????????? extdocURL ????????? package-list ???????????????????????????????????????????????????????????????????????????????????????????????????????????????extdocURL ???????????????????????????????????????

??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? URL ????????????????????????????????????????????????Javadoc ?????????????????????????????? package-list ?????????????????????????????????????????????????????????????????? URL ??????????????????????????????????????????????????????????????????????????????

?????????????????? - ????????? -link ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc 1.2 ?????????????????? -link ?????????????????????????????????????????????????????????????????????????????? 1.2.2 ???????????????????????????

????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

   % javadoc -link extdocURL1 -link extdocURL2 ...-link extdocURLn com.mypackage

extdocURL1???extdocURL2???... extdocURLn ???????????????????????????????????????????????????????????????????????????????????? package-list ??????????????????????????????????????????????????????

?????????????????? - ?????????????????????????????? 2 ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? package-list ??????????????????????????????????????????????????????????????????????????? javadoc ????????????????????????????????????2 ?????????????????????????????? package-list ?????????????????????????????????????????????????????????????????????????????????????????????2 ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

?????????????????????????????????????????????????????????????????????????????????????????? package-list ?????????????????????????????? ????????????????????????????????????????????????????????????package-list ?????????????????????????????????????????????????????????2 ?????????????????????????????????????????????????????????????????????????????????????????? package-list ???????????????????????????????????????Javadoc ???????????????????????????????????????

-linkoffline  extdocURL  packagelistLoc
???????????????????????????-link ?????????????????????????????????????????? ???????????????javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ????????????????????????????????????????????????????????? (Web ?????????????????????????????????????????????????????????????????????)???Web ???????????????????????????????????????????????????-linkoffline ????????????????????????????????????

?????????????????????????????????????????? package-list ?????????????????????????????????????????????????????????????????????????????? extdocURL ????????????????????????????????????????????? (?????????packageListLoc ???????????????????????????????????????) ????????????????????????-linkoffline ???????????????????????????????????????extdocURL ??? WWW ????????????????????????????????????????????????-linkoffline ?????????????????????????????????????????????????????????????????? javadoc ???????????? Web ??????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? javadoc ?????????????????????????????????????????????????????????????????????????????? javadoc ????????????????????? ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-linkoffline ??????????????????????????? 2 ?????????????????? ?????????????????? <a href> ???????????????????????????????????????????????????????????????2 ?????????????????? package-list ?????????????????????????????????????????????

  • extdocURL ??????????????????????????????????????????javadoc ??????????????????????????????????????????????????????????????????????????????????????? URL ??????????????? URL ????????????????????????????????????????????????-d ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-link ?????????????????? extdocURL ??????????????????????????????
  • packagelistLoc ???????????????????????????????????? package-list ?????????????????????????????????????????????????????????????????? URL ?????????????????????????????????URL (http: ????????? file:)or file:)??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????javadoc ????????????????????????????????????????????????????????????????????????????????????????????????package-list ?????????????????????????????????????????????????????????

javadoc ??? 1 ??????????????????????????? -linkoffline ???????????????????????????????????????1.2.2 ??????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????????????????????????? - http://java.sun.com/j2se/1.5.0/docs/api ?????? java.lang???java.io??????????????????????????? Java 2 ?????????????????????????????????????????????????????????????????????Web ??????????????????????????? ???????????????????????????????????????????????????????????????????????? http://java.sun.com/j2se/1.5.0/docs/api/package-list ????????? package-list ??????????????????????????????????????????????????????????????????????????? ????????????2 ??????????????? packagelistLoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? "." ??????????????????????????????????????????????????????Java 2 ???????????????????????? API ???????????????????????????com.mypackage ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? Object ???????????????????????????????????????????????????-sourcepath ??????????????????????????????????????????????????????????????????

% javadoc -linkoffline http://java.sun.com/j2se/1.5.0/docs/api . com.mypackage

????????????????????????????????????????????????????????? - ?????????-linkoffline ????????????????????????????????????????????????????????? -link ??????????????????????????????????????????-linkoffline ?????????????????????package-list ???????????????????????????????????????????????????????????? ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-linkoffline ??? 2 ????????????????????????????????????????????????????????????????????????2 ??????????????????????????????????????????-link ????????????????????????-link ??????????????????????????????????????????????????????

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

?????????????????????????????????????????? - -linkoffline ??????????????????????????????????????????????????? 1 ??????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????????????????????

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

??????????????????????????? - ????????? -linkoffline ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????[??????] ???????????????????????????????????????????????????????????????????????????

??????????????????????????????????????????????????????????????????????????? (update) ?????????????????????????????????????????????????????????????????? html ???????????????????????????????????????????????????html ??????????????????????????????????????????????????? (cd) ????????????-linkoffline ??????????????????????????????????????????????????? "." ???????????????2 ?????????????????? html ??????????????????????????????????????? ????????????package-list ???????????????????????? ???????????????????????????????????????????????????????????????????????????????????????

  % 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 ?????????????????????????????????????????????
  • groupheading ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
  • packagepattern ???????????????????????????????????????????????????????????????????????????????????????????????????????????? 1 ???????????????????????? (*) ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????1 ???????????????????????????????????? (:) ????????????????????????????????????????????????????????????????????????

???: ?????????????????????????????????????????????????????????????????????????????????"java.lang*:java.util" ?????????????????????????????????????????????????????????????????????????????????

-group ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 1 ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????????????????? 5 ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????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
???????????????????????????
java.new

-nodeprecated
?????????????????? API ??????????????????????????????????????????????????????????????????????????????????????????????????????-nodeprecatedlist ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? API ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-nodeprecatedlist
?????????????????? API ????????????????????????????????? (deprecated-list.html)????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? API ????????????????????????????????????????????????????????????????????? API ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-nosince
?????????????????????????????????@since ????????????????????????????????????????????????????????? ????????????????????????????????????

-notree
????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-noindex
??????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-nohelp
??????????????????????????????????????????????????????????????????????????????????????? [?????????] ??????????????????????????????

-nonavbar
??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????bottom ????????????????????????????????????????????????-nonavbar ??????????????????????????????????????????????????????????????? PostScript ????????? PDF ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

-helpfile  path/filename
???????????????????????????????????????????????? [?????????] ???????????????????????????????????????????????????????????? path/filename ???????????????????????????????????????????????????????????????????????????????????????Javadoc ????????????????????????????????????????????????????????????????????? help-doc.html ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????filename ???????????????????????????????????????????????????help-doc.html ??????????????????????????????????????????????????? 
  % javadoc -helpfile /home/user/myhelp.html java.awt
-stylesheetfile  path/filename
?????? HTML ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ????????????????????????????????????????????????????????????????????????????????? stylesheet.css ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????filename ???????????????????????????????????????????????????stylesheet.css ??????????????????????????????????????????????????? 
  % javadoc -stylesheetfile /home/user/mystylesheet.css com.mypackage
-serialwarn
@serial ???????????????????????????????????????????????????????????????????????????????????????????????????Javadoc 1.2.2 ??????????????????????????????????????????????????????????????????????????????1.2.2 ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? writeExternal ???????????????????????????????????????????????????????????????????????????

-charset  name
?????????????????????????????? HTML ??????????????????????????????????????????????????????IANA Registry ???????????????????????????????????? MIME ????????????????????????????????????????????????????????? 
  % javadoc -charset "iso-8859-1" mypackage
???????????????????????????????????????????????????????????????????????????????????? 
   <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
?????? META ????????????????????????HTML ????????? (4197265 ????????? 4137321) ??????????????????????????????

-encoding ????????? -docencoding ??????????????????????????????

-docencoding  name
??????????????? HTML ??????????????????????????????????????????????????????????????????????????????IANA Registry ???????????????????????????????????? MIME ?????????????????????????????????????????????????????????????????????????????? -encoding ??????????????????????????????????????? HTML ????????????????????????????????????-encoding ????????????????????????????????????: 
  % javadoc -docencoding "ISO-8859-1" mypackage
-encoding ????????? -charset ??????????????????????????????

-keywords
HTML ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????? Web ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 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 ?????????????????????????????????

????????? (:) ??????????????????????????????????????????tagname ?????????????????????????????????????????????????????????????????????????????????????????????????????????

-tag ??????????????????????????????????????????taghead????????????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ???????????????????????????????????????????????????????????????????????? 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.
???????????????????????????????????? - ????????? (:) ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 
    /**
     * @ejb:bean
     */
??????????????????????????????????????????????????? 
    -tag ejb\\:bean:a:"EJB Bean:"
????????????????????????????????? (??????????????????) - ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????X ????????????????????????????????????????????????????????????????????????????????? ??????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Javadoc ???????????????????????????????????????

???????????????????????????????????? X ???????????????????????? ????????????????????????X ???????????????????????????????????????????????????????????????????????????????????????@todo ???????????????????????????????????????????????????????????????????????????

    -tag todo:Xcmf:"To Do:"
???????????????????????????????????????????????? 
    -tag todo:X

?????? -tag todo:X ??????@todo ??? taglet ????????????????????????????????????????????????

??????????????? - -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 ???????????????????????? (.) ?????????????????????????????????????????????Sun ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Sun ???????????????????????????????????????????????????????????????????????????????????????????????????????????? @todo ??????????????????????????????????????????????????????????????????????????????Sun ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

?????? vs. Javadoc ?????? - ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? javadoc ??????????????????????????? ??????????????????????????????????????????????????????Comparing Annotations and Javadoc Tags?????????????????????????????????

-taglet ????????????????????????????????????????????????????????????????????????????????????????????????????????? ????????????????????????????????????

-taglet  class
?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

????????????????????????????????????????????????-tagletpath ??????????????????????????????????????????????????????????????????????????????Parameter?????????Throws???????????????To Do?????????????????????????????????????????????

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

-tag ?????????????????????????????? -taglet ????????????????????????????????????????????????????????????????????????????????????????????????-tag ????????????????????????????????????????????????????????????

-tagletpath  tagletpathlist
taglet ????????????????????? (.class) ????????????????????????????????????tagletpathlist ?????????????????? (:) ??????????????????????????????????????????????????????????????????Javadoc ??????????????????????????????????????????????????????????????????????????????????????????????????????

-docfilessubdirs 
doc-files ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????doc-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 ?????????????????????????????????????????????????????????Javadoc ??? 2 ???????????????????????????????????????????????????????????? diff ??????????????????????????????????????????????????????????????????????????????????????????????????? diff ?????????????????????????????????????????? (???????????????????????????????????????????????????????????? diff ???????????????)?????????????????????????????? Javadoc ?????????????????????????????????????????????????????????????????????????????? 
     <!-- Generated by javadoc (build 1.5.0-internal) on Tue Jun 22 09:57:24 PDT 2004 -->

-nocomment 
???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? HTML ???????????????????????????????????????????????????????????????

?????????????????????????????????

javadoc ????????????????????????????????????????????????????????????????????????javadoc ?????????????????????????????? (-J ????????????????????????) ???????????? 1 ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? javadoc ????????????????????????????????????

???????????????????????????javac ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

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

javadoc ??????????????????????????????????????????????????????????????????????????????????????? @ ?????????????????????????????????javadoc ??????@ ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

????????????????????? 1 ??????????????????

argfile ??????????????????????????????????????????????????? Javadoc ????????????????????????????????????????????????????????????????????????

  % javadoc @argfile

??????????????????????????????????????????????????????????????? 2 ???????????????????????????????????????????????????????????????????????????

????????????????????? 2 ??????????????????

Javadoc ????????????????????? 1 ???????????????????????????????????? 1 ????????????????????????2 ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????? options ???????????????????????????????????????????????????

     -d docs-filelist 
     -use 
     -splitindex
     -windowtitle 'Java 2 Platform v1.3 API Specification'
     -doctitle 'Java<sup><font size="-2">TM</font></sup> 2 Platform 5.0 API Specification'
     -header '<b>Java 2 Platform </b><br><font size="-1">5.0</font>'
     -bottom 'Copyright 1993-2000 Sun Microsystems, Inc. All Rights Reserved.'
     -group "Core Packages" "java.*"
     -overview /java/pubs/ws/1.5/src/share/classes/overview-core.html
     -sourcepath /java/pubs/ws/1.5/src/share/classes

???????????????????????? packages ???????????????????????????????????????????????????

     com.mypackage1
     com.mypackage2
     com.mypackage3

???????????????????????????????????????????????? javadoc ?????????????????????

  % javadoc @options @packages

???????????????????????????????????????

????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ????????????????????????????????????path1 ??? path2 ????????????????????????????????????????????????

  % javadoc @path1/options @path2/packages

??????????????????????????????

?????????Javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????????????????-bottom ?????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????bottom ???????????????????????????????????????????????????

'<font size="-1"><a href="http://java.sun.com/cgi-bin/bugreport.cgi">Submit a 
bug or feature</a><br><br>Java is a trademark or registered trademark of 
Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993-2000 Sun 
Microsystems, Inc. 901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A. 
All Rights Reserved.</font>'

???????????????????????????????????? Javadoc ??????????????????????????????

  % javadoc -bottom @bottom @packages

??????????????????????????????????????? -bottom ???????????????????????????????????????????????????????????????????????????????????????

  % javadoc @bottom @packages

??????

Javadoc ?????????

????????????????????? - javadoc ????????????????????????????????????????????????javadoc -J-version ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-quiet ???????????????????????????

?????????????????????????????????????????? - Java ????????????????????????????????????????????? Javadoc ?????????????????????????????????????????????????????????????????????????????? com.sun.tools.javadoc.Main ??????????????? (javadoc ???????????????)???????????????????????????????????????????????????????????????????????????

??????????????????????????? - ??????????????????????????? HTML ???????????????????????????????????????????????????????????????????????????????????????????????????????????????-doclet ????????? -docletpath ????????????????????????????????????????????????????????????????????????????????????????????????????????????MIF Doclet ???????????????????????????????????????????????????

????????????

javadoc ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? /home/src/java/awt/*.java ???????????????????????????????????????????????? /home/html ?????????

1 ???????????????????????????????????????????????????

??????????????????????????????????????????????????????????????????????????????????????????????????? (*.java) ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (java.awt.color ???????????????????????????????????????????????????????????????) ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? (java/awt/color ??????)???1 ????????????????????????????????????????????????????????????????????????????????????????????? 2 ?????????????????????????????????????????????????????????????????????????????? (src1/java/awt/color ??? src2/java/awt/color ??????)??? ??????????????????????????????-sourcepath ??????????????????????????????????????????????????????????????????????????????

javadoc ????????????????????????cd ???????????????????????????????????????????????????????????????????????? -sourcepath ??????????????????????????????????????????????????????????????????????????????????????????????????????

??????: ?????????????????????????????????java.awt ??? java.awt.event ????????????????????? public ????????? protected ????????????????????????????????????????????????HTML ??????????????????????????????????????????????????????????????????????????????????????? (/home/html) ??? HTML ????????????????????????????????????2 ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 3 ???????????????????????????????????????????????????

1 ?????????????????????????????????????????????

?????????1 ????????????????????????????????? (.java) ???????????????Javadoc ????????????????????????????????????????????????javadoc ???????????? 2 ??????????????????????????????????????????????????? 1 ?????????cd ??????????????????????????????????????????????????????????????? 1 ?????? .java ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-sourcepath ????????????????????????????????????????????????????????? (*) ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

???????????????????????????????????????????????????

???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? 2 ???????????????????????????????????????????????????-sourcepath ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

  % javadoc -d /home/html -sourcepath /home/src java.awt /home/src/java/applet/Applet.java

????????????????????????????????? java.awt ??????????????? Applet ???????????????HTML ???????????????????????????????????????????????????Javadoc ???????????????Applet ???????????????????????????Applet.java ???????????????????????????????????????????????? (???????????????????????????) ????????????????????????

?????????

Javadoc ???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????Java ???????????????????????? API ???????????? Javadoc ???????????????????????????????????????????????????????????????????????????Java 2 Platform, Standard Edition, v1.2 ????????????????????? 1500 ?????? public ????????? protected ??????????????????????????????????????????????????????????????????180M ????????????????????????????????????????????????

???????????? 2 ????????????????????? ????????????????????????????????????????????????????????????2 ??????????????? Makefile ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? javadoc ????????????????????????????????????

?????????????????????

?????????????????????????????? 900 ?????????????????????????????????DOS ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????????

% javadoc -sourcepath /java/jdk/src/share/classes            \
    -overview /java/jdk/src/share/classes/overview.html      \
    -d /java/jdk/build/api                                   \
    -use                                                     \
    -splitIndex                                              \
    -windowtitle 'Java 2 Platform 5.0 API Specification'    \
    -doctitle 'Java<sup><font size="-2">TM</font></sup> 2 Platform 5.0 API Specification' \
    -header '<b>Java 2 Platform </b><br><font size="-1">5.0</font>' \
    -bottom '<font size="-1"><a href="http://java.sun.com/cgi-bin/bugreport.cgi">Submit 
a bug or feature</a><br><br>Java is a trademark or registered trademark of Sun Microsystems, 
Inc. in the US and other countries.<br>Copyright 1993-1999 Sun Microsystems, Inc. 
901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A. All Rights Reserved.</font>' \  
    -group "Core Packages" "java.*:com.sun.java.*:org.omg.*" \
    -group "Extension Packages" "javax.*"                    \
    -J-Xmx180m                                               \  
    @packages

???????????????????????????packages ??????????????????????????????????????? (java.applet java.lang ??????) ??????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-bottom ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

Makefile ??????

???????????????GNU Makefile ????????????????????????Windows ??? Makefile ????????????????????????Windows ??? Makefile ?????????????????????????????????????????????

javadoc -sourcepath $(SRCDIR)              \   /* Sets path for source files     */
        -overview $(SRCDIR)/overview.html  \   /* Sets file for overview text    */
        -d /java/jdk/build/api             \   /* Sets destination directory     */
        -use                               \   /* Adds "Use" files               */
        -splitIndex                        \   /* Splits index A-Z               */
        -windowtitle $(WINDOWTITLE)        \   /* Adds a window title            */
        -doctitle $(DOCTITLE)              \   /* Adds a doc title               */
        -header $(HEADER)                  \   /* Adds running header text       */
        -bottom $(BOTTOM)                  \   /* Adds text at bottom            */
        -group $(GROUPCORE)                \   /* 1st subhead on overview page   */
        -group $(GROUPEXT)                 \   /* 2nd subhead on overview page   */
        -J-Xmx180m                         \   /* Sets memory to 180MB           */
        java.lang java.lang.reflect        \   /* Sets packages to document      */
        java.util java.io java.net         \
        java.applet
        
WINDOWTITLE = 'Java 2 Platform v1.2 API Specification'
DOCTITLE = 'Java<sup><font size="-2">TM</font></sup> 2 Platform v1.2 API Specification'
HEADER = '<b>Java 2 Platform </b><br><font size="-1">v1.2</font>'
BOTTOM = '<font size="-1"><a href="http://java.sun.com/cgi-bin/bugreport.cgi">Submit
    a bug or feature</a><br><br>Java is a trademark or registered trademark 
    of Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993-1999    
    Sun Microsystems, Inc. 901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A.  
    All Rights Reserved.</font>'
GROUPCORE = '"Core Packages" "java.*:com.sun.java.*:org.omg.*"'
GROUPEXT  = '"Extension Packages" "javax.*"'
SRCDIR = '/java/jdk/1.2/src/share/classes'

Makefile ????????????????????????????????????????????????

???

?????????????????????????????????

?????????????????????????????????????????????

??????????????????

??????????????????????????????????????????????????????????????????????????? (????????????????????????????????????????????????????????????????????????) ?????????????????????????????????

??????

CLASSPATH
Javadoc ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????-classpath ????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
.:/home/classes:/usr/local/java/classes

????????????

Copyright © 1995-2010 Sun Microsystems, Inc. All Rights Reserved.

Please send comments using this Feedback page. 		Sun Microsystems, Inc.
Java Technology