Sindbad~EG File Manager
'\" t
.\" @(#)javadoc.1 1.12 00/06/13 SMI;
.\" Copyright 2003 Sun Microsystems, Inc. All rights reserved.
.\" Copyright 2003 Sun Microsystems, Inc. Tous droits r��erv��.
.\"
.TH javadoc 1 "2006 ǯ 9 �� 4 �" "Java SE 6" "�桼�������ޥ��"
.hw javadoc
.SH "̾��"
javadoc \- Java API �ɥ�����ȥ����ͥ졼��
.RS 3
.LP
.LP
Java �������ե����뤫�顢API �ɥ�����Ȥ� HTML �ڡ���������ޤ������Υɥ�����ȤǾҲ𤵤�Ƥ��� Javadoc ����ϡ�Sun Solaris ����Ѥ������Τ�ΤǤ���
.LP
.SH "����"
.B javadoc
[
.I options
] [
.I packagenames
] [
.I sourcefilenames
] [
.I \-subpackages pkg1:pkg2:...
] [
.I @argfiles
]
.LP
.LP
�������ꤹ�����Ǥ�դǤ���Javadoc �ġ���ǤΡ�����оݤ� \f2.java\fP �ե��������ꤹ���ˡ�ξܺ٤ˤĤ��Ƥϡ��֥������ե�����ν���פȤ��Ƥ���������
.TP 15
.I options
���Υɥ�����Ȥǻ��ꤵ��Ƥ��륳�ޥ�ɹԥ��ץ����Ǥ���
.B javadoc
�Υ��ץ����ΰ���Ū�ʻ���ˡ�ˤĤ��Ƥϡ��ֻ�����פȤ��Ƥ���������
.TP
.I packagenames
.BR "java.lang java.lang.reflect java.awt"
�ʤɤΡ����ڡ����Ƕ�ڤ�줿
��Ϣ�Υѥå�����̾�Ǥ����ɥ�����Ȳ�����ѥå��������Ȥ��̸Ĥ�
���ꤹ��ɬ�פ�����ޤ���
.B javadoc
�ġ���Ϥ����Υѥå�����̾��õ���Ȥ���
.B \-sourcepath
����Ѥ��ޤ���
.B javadoc
�ġ���ϡ����֥ѥå�������Ƶ�Ū�˽�����뤳�ȤϤ���ޤ���
�������ꥹ�� (\f3*\f1) �ʤɤΥ磻��ɥ����ɤϻȤ����Ȥ��Ǥ��ޤ���
��1 �İʾ�Υѥå������Υɥ�����Ȳ��פ�
��Ȥ��Ƥ���������
.TP
.I sourcefilenames
���ڡ����Ƕ�ڤ�줿��Ϣ�Υե�����̾�Ǥ����ѥ��������
�������ꥹ�� (\f3*\f1) �ʤɤΥ磻��ɥ����ɤ�ޤ�뤳�Ȥ��Ǥ��ޤ���
.B javadoc
�ġ��뤬�������Τϡ��ե�����̾����.java�פȤ�����ĥ�Ҥǽ���ꡢ
���γ�ĥ�Ҥ����̾�����ºݤ�ͭ���ʥ��饹̾
.fi
(http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625
��
.na
��\f2Identifiers\fP�פ�) �Ǥ��뤹�٤ƤΥե�����Ǥ���
�������äơ��ϥ��ե��ޤ�̾�� (X-Buffer �ʤ�) �䡢
����¾��̵����ʸ����ޤ�̾�����դ��뤳�Ȥˤ�äơ�
�����Υե������ɥ�����Ȳ����оݤ������Ǥ��ޤ���
����ϡ��ƥ����ѤΥե�����䡢�ƥ�ץ졼�Ȥ��������줿�ե�����ξ�������Ǥ���
.B javadoc
�ġ���ϡ��������ե�����̾����˻��ꤵ�줿�ѥ�����Ѥ��ơ�
�������ե�����̾��õ���ޤ������ξ�硢
.B -sourcepath
�ϻ��Ѥ��ޤ����Ȥ��С�
.B Button.java
���Ϥ����Ȥ�
.BR ./Button.java
�Ȼ��ꤹ�뤳�Ȥ�Ʊ���Ǥ��������ѥ����դ����������ե�����̾��
��ϡ�
.BR /home/src/java/awt/Graphics*.java
�פΤ褦�ˤʤ�ޤ�����1 �İʾ�Υ��饹�Υɥ�����Ȳ��פ����
���Ȥ��Ƥ����������ޤ����֥ѥå������ȥ��饹�Υɥ�����Ȳ��פ�
��Τ褦�ˡ��ѥå�����̾�ȥ������ե�����̾��Ȥ߹�碌�뤳�Ȥ�Ǥ��ޤ���
.TP
.I \-subpackages pkg1:pkg2:...
���ꤵ�줿�ѥå�������Υ������ե����뤫��ɥ�����Ȥ������
�Ƶ�Ū�˥��֥ѥå������������ޤ��� �ѥå�����̾�ޤ���
������ե�����̾����ꤹ�뤿������ؼ��ʤǤ���
.TP
.I @argfiles
Javadoc ���ץ���ѥå�����̾������ӥ������ե�����̾��
Ǥ�դν����¤٤��ꥹ�Ȥ��ޤޤ�� 1 �İʾ�Υե�����Ǥ���
���Υե��������Ǥϡ��磻��ɥ����� (*) �����
.B \-J
���ץ����ϻ���Ǥ��ޤ���
.SH "��ǽ���"
.B javadoc
�ġ���ϡ���Ϣ�� Java �������ե�����������ӥɥ������
�����Ȥ��Ϥ����ǥե���ȤǤ� public ���饹�� protected ���饹��
���ҥ��饹��ƿ̾������饹����ˡ����ե����������ȥ饯������åɡ������
�ե�����ɤˤĤ�����������Ϣ�� HTML �ڡ���������ޤ����ޤ���API (���ץꥱ�������ץ���ߥ��ե�����) �ɥ�����Ȥ�����䡢��Ϣ�Υ������ե�����μ���ɥ�����Ȥ�����˻��ѤǤ��ޤ���
.LP
.B javadoc
�ġ���ϡ��ѥå��������Ρ��ġ��Υ������ե����롢�ޤ��Ϥ���ξ����Ф���
�¹ԤǤ��ޤ���
.B javadoc
�ġ����ѥå��������Τ��Ф��Ƽ¹Ԥ�����ϡ��Ǿ�̥ǥ��쥯�ȥ꤫��Ƶ�Ū�ˤ��ɤ뤿��� -subpackages ����Ѥ��뤫���ѥå�����̾�����Ū�ʥꥹ�Ȥ��Ϥ��ޤ���
�ġ��Υ��饹���Ф��� javadoc ��¹Ԥ�����ϡ���Ϣ��
������ (\f3.java\f1) �ե�����̾���Ϥ��ޤ�������Ū����ϡ�
���Υڡ����κǸ�Ǽ����ޤ���
���ˡ�Javadoc �ˤ�륽�����ե�����ν���ˤĤ��������ޤ���
.LP
.SS
�������ե�����ν��
.LP
.LP
Javadoc �ġ���ϡ����� \f2.java\fP ���դ����ե�����ʳ��ˡ��������ե������������¾�Υե�����������ޤ����ġ��Υ������ե�����̾�����Ū���Ϥ����Ȥˤ�ä� Javadoc �ġ����¹Ԥ����硢\f2.java\fP �ե�����������뤫��Τ˻���Ǥ��ޤ�����������¿���γ�ȯ�ԤϤ����ˡ�ǤϺ�Ȥ��ޤ��ѥå�����̾���Ϥ��ۤ�����ñ������Ǥ����������ե�����̾�����Ū�˻��ꤷ�ʤ��Ƥ⡢Javadoc �ġ���� 3 �Ĥ��ˡ�Ǽ¹ԤǤ��ޤ��������ˡ�ϡ�(1) �ѥå�����̾���Ϥ���(2) \f2\-subpackages\fP ����Ѥ��롢(3) �������ե�����̾�˥磻��ɥ����ɤ���Ѥ��� (\f2*.java\fP) �Ȥ����ˡ�Ǥ����������ˡ����Ѥ����硢Javadoc �ġ���ϡ�\f2*.java\fP �ե����뤬���Τ��٤Ƥ����������Ƥ�����ˤ����ꡢ���Υե�����������ޤ���
.LP
.RS 3
.TP 2
o
̾������ \f2.java\fP �������������ȡ��ºݤ�ͭ���ʥ��饹̾�ˤʤäƤ��� (ͭ����ʸ���ˤĤ��Ƥϡ�
.fi
http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625
��
.na
��\f2Identifiers\fP�פ�)
.TP 2
o
�������ĥ�Υ롼�Ȥ������Ū�ʥǥ��쥯�ȥ�ѥ�������ڤ�ʸ����ɥåȤ��Ѵ�����ȡ��ºݤ�ͭ���ʥѥå�����̾�ˤʤäƤ���
.TP 2
o
�ѥå�����ʸ�ˤ�ͭ���ʥѥå�����̾���ޤޤ�� (�����ܤǻ���)
.RE
.LP
.LP
\f3���\fP \-
�¹Ի��ˡ�
.B javadoc
�ġ���Ϥ��μ¹Ԥΰ���Ȥ��Ƶ��Ҥ���Ƥ���ѥå����������饹��
����ӥ��Ф�̾�Τ˥�����ե�����ưŪ��
�ɲä��ޤ�����ϡ����βս�˸����ޤ���
.LP
.TP 2
\(bu
�� (����ͤη�������η����ե�����ɤη�)
.TP 2
\(bu
@see ��������������� [��Ϣ����] �Υ��������
.TP 2
\(bu
{@link} ��������������륤��饤��ƥ�����
.TP 2
\(bu
@throws ����������������㳰��̾��
.TP 2
\(bu
���ե������Υ��Ф��Ф��� [��] ��ȡ����饹�Υ��Ф��Ф��� [�����С��饤��] ���
.TP 2
\(bu
�ѥå����������饹������ӥ��ФҤ������ɽ
.TP 2
\(bu
�ѥå������ȥ��饹�ηѾ��ĥ
.TP 2
\(bu
����
.LP
\-link �� \-linkoffline ���ץ�������Ѥ��ơ�
���ޥ�ɹԤ˴ޤޤ�Ƥ��ʤ������̤��������륯�饹�δ�¸�Υƥ����Ȥ�
�ϥ��ѡ�����ɲäǤ��ޤ���
.LP
\f3����¾�ν���ˤĤ��Ƥξܺ�\fP \-
javadoc �ġ���ϡ��¹ԤΤ��ӤˤҤȤĤδ����ʥɥ�����Ȥ�����ޤ���javadoc �ϡ�
�ɲ������Ԥ��ޤ��Ĥޤꡢ����˼¹Ԥ��� javadoc �η�̤��ѹ������ꡢ
������ľ�ܼ���ळ�ȤϤǤ��ޤ������������ҤΤ褦�ˤۤ���
�¹Ԥη�̤˥���뤳�Ȥϲ�ǽ�Ǥ���
.LP
�������ͳ���顢
.B javadoc
�ġ���ϼ¹Ԥ� java ����ѥ����ɬ�פȤ���java ����ѥ���˰�¸���Ƥ��ޤ���
.B javadoc
�ġ����
.B javac
�ΰ����ƤӽФ��ơ�����ѥ��뤷�����Фμ����̵�뤷�ޤ���
.B javadoc
�ġ���ϡ����饹���ؤ�ޤ९�饹��˭�٤�����ɽ��������ӡֻ��ѡ״ط���
���ۤ����������� HTML ������ޤ���
.B javadoc
�ġ���ϡ������������ɤΥɥ�����ơ�������Ȥ��顢�桼����
����ɥ�����Ȥ������ޤ���
.LP
.B javadoc
�ġ���ϡ���å����ΤΤʤ����ʥ����֥ե�����Ǥ���
.B .java
�������ե������Ǽ¹Ԥ���ޤ����ĤޤꡢAPI �κ����ˤϡ������ɤ�
���Ҥ�����߷פ�ᤤ�ʳ��ǥɥ�����ơ�������ȤҤ���
.B javadoc
��¹ԤǤ��ޤ���
.LP
����ѥ���˰�¸���뤳�Ȥˤ�äơ�HTML ���Ϥ����ºݤμ������Τ��б�
���뤳�Ȥ��ݾڤ���ޤ����ºݤμ���ϡ����Ū�Ǥʤ�����Ū��
�����������ɤ˰�¸���Ƥ����礬����ޤ������Ȥ��С�
.B javadoc
�ġ���ϡ�
.B .class
�ե�������ˤ�¸�ߤ��뤬����������������ˤ�¸�ߤ��ʤ�
�ǥե���ȥ��ȥ饯�� (��Java Language Specification�פΥ�������� 8.6.7: http://java.sun.com/docs/books/jls/second_edition/html/names.doc.html#36154)
��ɥ�����Ȳ����ޤ���
.LP
¿���ξ�硢
.B javadoc
�ġ���Ǥϡ��������ե�����Υ����ɤ��Դ����ޤ��ϥ��顼��
�ޤ�Ǥ�����Ǥ�ɥ�����Ȥ���Ǥ��ޤ���
���Τ��ᡢ�ǥХå���ȥ�֥륷�塼�ƥ�����λ������
�ɥ�����Ȥ���Ǥ��ޤ��� ���Ȥ��С�Java ������ͤˤ��ȡ�
��ݥ�åɤ�ޤ९�饹�Ϥ��켫�Τ���ݤ�����ʤ���Фʤ�ޤ���
���Υ��顼�Ф���ȡ�javac ����ѥ���ξ��ϡ����Υ��顼��
��ߤ��ޤ�����javadoc �ġ���Ϸٹ��Ф����˽����ʤ�ޤ���
javadoc �ġ���ϥɥ�����ơ�������Ȥδ���Ū�ʥ����å���Ԥ��ޤ���
�ɥ�����ơ�������Ȥ���ܤ��������å�����ɬ�פ�������ϡ�
DocCheck �ɥå���åȤ���Ѥ��Ƥ���������
.LP
.B javadoc
�ġ��뤬�ɥ�������Ѥ�����¤���ۤ���Ȥ��ϡ����Ȥ���
���饹�٤ƥ��ɤ��ޤ������Τ��ᡢ�֡��ȥ��ȥ�åץ��饹��
��ĥ��ǽ���ޤ��ϥ桼�����饹�ˤ�����餺��
.B javadoc
�ġ���ϡ����Ȥ��륯�饹�٤Ƹ��ФǤ��ʤ���Фʤ�ޤ���
����Ū�ˡ�������
���饹�ϡ���ĥ��ǽ�Ȥ��ƥ��ɤ���뤫��
.BR javadoc
�ġ���Υ��饹�ѥ���ˤ���ɬ�פ�����ޤ���
.SS "Javadoc �ɥå���å�"
.B javadoc
�ġ���ν��Ϥ����Ƥȷ����ϡ��ɥå���åȤ�Ȥäƥ������ޥ����Ǥ��ޤ���
.B javadoc
�ġ���ˤϡ�ɸ��ɥå���åȤȸƤФ��ǥե���ȤΡ�Ȥ߹��߷���
�ɥå���åȤ����ꡢ����ˤ�ä� HTML ������ API
�ɥ�����Ȥ�����ޤ���ɸ��ɥå���å�
�ν����䥵�֥��饹����Ԥʤä��ꡢHTML��XML��MIF��RTF �ʤɤι��ߤ�
���Ϸ�����������ȼ��Υɥå���åȤҤ��뤳�Ȥ��ǽ�Ǥ���
�ɥå���åȤȤ��λ���ˡ�ˤĤ��Ƥϡ����Ȥ��Ƥ���������
.LP
.TP 2
\(bu
.B Javadoc
�ɥå���å�
.TP 2
\(bu
.B -doclet
���ޥ�ɹԥ��ץ����
.LP
.B -doclet
���ޥ�ɹԥ��ץ����ǥ�������ɥå���åȤ����ꤵ��Ƥ��ʤ���硢
.B javadoc
�ġ���ϡ��ǥե���Ȥ�ɸ��ɥå���åȤ���Ѥ��ޤ���
.B javadoc
�ġ���ˤϡ��ɤΥɥå���åȤ��Ȥ��Ƥ��뤫�ˤϴط��ʤ����ѤǤ���
���ޥ�ɹԥ��ץ������ޤ���ɸ��ɥå���åȤǤϡ�������
�ۤ��ˡ������Ĥ��Υ��ޥ�ɹԥ��ץ�����ɲä���ޤ����ɤ����
���ץ����ˤĤ��Ƥ⡢��ҤΡ֥��ץ����פ������ޤ���
.SS ��Ϣ�ɥ�����Ȥ���ӥɥå���å�
.TP 2
\(bu
Javadoc �˻ܤ��줿��ǽ���� - Javadoc ���ɲä��줿������ξܺ�
.TP 2
\(bu
Javadoc FAQ - ���ˤ˴�������Ф�������Javadoc ��Ϣ�Υġ���ˤĤ��Ƥξ�����ӥХ��β����ˡ
.TP 2
\(bu
Javadoc �Υɥ�����ơ������������ˤ� - Sun ��
����Ū�ʥɥ�����ơ�������Ȥε����ˡ�ξܺ�
.TP 2
\(bu
API ���ͤҤ��뤿����� - Java 2 �ץ�åȥե�������ͤҤ���ݤ�
���Ѥ��줿ɸ��� ���ξ���ϡ��������ե�����Υɥ�����ơ��������
������ API ���ͤҤ�����ˤ⡢����¾�η����ǵ��Ҥ�����ˤ�
��Ω���ޤ��� ���ڲ�ǽ�ʥ�����������������ѥå����������饹��
���ե��������ե�����ɡ�����ӥ�åɤˤĤ��Ƥ�������Ƥ��ޤ���
.TP 2
\(bu
�ɥ�����ơ�������Ȥλ��� - �ɥ�����ơ�������Ȥ�
���ꥸ�ʥ���ͤˤĤ��Ƥϡ���Java Language Specification��
(James Gosling��Bill Joy��Guy Steele ���) �ν��Ǥ�
�� 18 �ϡ�Documentation Comments�פȤ��Ƥ���������
���ξϤϡ��� 2 �ǤǤϺ�����ޤ�����
.TP 2
\(bu
DocCheck �ɥå���å� - �������ե�������Υɥ�����ơ�������Ȥ�����
���Ĥ��ä����顼���Ե�§�ʲս�����ˤ�����ݡ��Ȥ�����ޤ���
����� Sun Doc �����å��桼�ƥ���ƥ��ΰ���Ǥ���
.TP 2
\(bu
MIF �ɥå���å� - MIF��FrameMaker������� PDF �����Ǥ� API �ɥ�����Ȥ�
������ư�����ޤ��� MIF �� Adobe FrameMaker �θߴ������Ǥ���
.SS "�Ѹ�"
.LP
.LP
��\f2�ɥ�����ơ��������\fP�ס���\f2doc ������\fP�ס���\f2����\fP�ס���\f2����\fP�ס���\f2�֥�å�����\fP�ס�����ӡ�\f2����饤��\fP�פ��Ѹ�ˤĤ��Ƥϡ��֥ɥ�����ơ�������ȡפ������ޤ����ʲ��Τ���¾���Ѹ�ϡ�Javadoc �ġ���Υ���ƥ����Ȥ�����ΰ�̣����ޤ���
.RS 3
.TP 3
���������ɥ������
.B javadoc
�ġ��뤬 Java ��������������� doc �����Ȥ����������ɥ������
�Τ��ȤǤ����ǥե���Ȥ�����ɥ�����Ȥ� HTML �����ǡ�ɸ��
�ɥå���åȤˤ�äƺ�����ޤ���
.LP
.TP 3
̾��
Java ����Ǥ�̾�����Ĥޤ�ѥå����������饹�����ե�������
�ե�����ɡ����ȥ饯�����ޤ��ϥ�åɤ�̾���Τ��ȤǤ���̾���ϡ�
.BR java.lang.String.equals(java.lang.Object)
�Τ褦�˴����������뤳�Ȥ⡢
.BR equals(Object)
�Τ褦����ʬ�������뤳�Ȥ�Ǥ��ޤ���
.LP
.TP 3
�ɥ�����Ȳ�����륯�饹
.B javadoc
�μ¹Ԥˤ�äƴ����ʥɥ�����Ȥ���������륯�饹��
���ե������Ǥ����ɥ�����Ȳ�����ˤϡ��������ե����뤬
���Ѳ�ǽ�Ǥʤ���Фʤ餺���������ե�����̾�ޤ��ϥѥå�����̾��
�ɤ��餫��
.B javadoc
���ޥ�ɤ��Ϥ��ʤ���Фʤ�ޤ��ɥ�����Ȳ�����륯�饹�ϡ�
.B javadoc
�μ¹Ԥ�Ȥ߹��ޤ�륯�饹���Ĥޤ��Ȥ߹��ߥ��饹�פȤ�ƤФ�ޤ���
.LP
.TP 3
�ޤޤ�륯�饹
�б����륽�����ե�����̾�ޤ��ϥѥå�����̾�� javadoc ���ޥ�ɤ�
�Ϥ���륯�饹����ӥ��ե������Τ��ȤǤ���
.LP
.TP 3
��������륯�饹
javadoc ���ޥ�ɤ˥������ե�����̾�ޤ��ϥѥå�����̾��
�Ϥ���ʤ����饹�ȥ��ե������Ǥ���
.LP
.TP 3
���ȥ��饹
�ɥ�����Ȳ�����륯�饹�ȥ��ե���������
(���) �ޤ��ϥɥ�����ơ��������������Ū�˻��Ȥ����
���饹�ȥ��ե������Ǥ������Ȥ���Ȥ��Ƥϡ�
����ͤη����ѥ����η������㥹�Ȥη���
��ĥ����륯�饹���������륤�ե�������
����ݡ��Ȥ���륯�饹����å����Τǻ��Ѥ����
���饹��@see��{@link}��{@linkplain}��
����� {@inheritDoc} �����ʤɤ�����ޤ�
(�������� 1.3
.fi
(http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/javadoc.html#referencedclasses)
����
�ѹ�����Ƥ��뤳�Ȥ����)��
javadoc �ġ����ư���桢
.B javadoc
�Υ֡��ȥ��饹�ѥ���
���饹�ѥ���ˤ��뻲�Ȥ���Ƥ��륯�饹��
���٤ƥ���˥��ɤ��뤿��Ǥ���
���Ȥ���Ƥ��륯�饹�����Ĥ���ʤ��ä�
���ϡ�[���饹�����Ĥ���ޤ���] �Ȥ����ٹ�ɽ������ޤ���
.B javadoc
�ġ���ϡ����饹��¸�ߤȤ��Υ��Фδ�������̾����ꤹ��Τ˽�ʬ�ʾ����
.B .class
�ե����뤫�����Ф����Ȥ��Ǥ��ޤ���
.LP
.TP 3
����ȥ��饹
���Ȥ���륯�饹�Τ�����
.B javadoc
��¹Ԥ��Ƥ�ɥ�����Ȥ���������ʤ����饹�Ǥ���
�Ĥޤꡢ�����Υ��饹�ϡ����ޥ�ɹԤ�
.B javadoc
�ġ�����Ϥ���Ƥ��ޤ���
�����ɥ��������Ǥ����Υ��饹�˥���Ƥ���ս�ϡ�
�ֳ���ȡפޤ��ϡֳ����פȸƤФ�ޤ��� ���Ȥ��С�
.B java.awt
�ѥå��������Ф��Ƥ���
.B javadoc
��¹Ԥ�����硢Object �ʤɤ�
.BR java.lang
��Τ��٤ƤΥ��饹�ϡ�����ȥ��饹�ˤʤ�ޤ�������ȥ��饹�ˤϡ�
.B \-link
�����
.B \-linkoffline
���ץ�����Ȥäƥ���뤳�Ȥ��Ǥ��ޤ���
����ȥ��饹�ˤϡ��̾綠�Υ����������Ȥ�
.B \javadoc
�ġ���μ¹Ԥ���ѤǤ��ʤ��Ȥ������פ���ħ������ޤ���
���ξ�硢�����Υ����Ȥ�Ѿ����뤳�ȤϤǤ��ޤ���
.SH "�������ե�����"
.B javadoc
�ġ���ϡ����饹�� Java ���쥽�����ե����� (\f3.java\f1)���ѥå����������ȥե����롢
���ץ����ȥե����롢����Ӥ���¾�ν������ʤ��ե������ 4 �����
�֥������ץե�������ˤ��ơ����Ϥ�����ޤ����ޤ����ɥ�����Ȳ����ʤ����������ĥ��¸�ߤ����礬����ƥ��ȥե������ƥ�ץ졼�ȤˤĤ��Ƥ������ޤ���
.SS "���饹�����������ɥե�����"
�ƥ��饹�ޤ��ϥ��ե�����������Ӥ��Υ��Фϡ�
.B .java
�ե��������ˤ��켫�ȤΥɥ�����ơ�������Ȥ�
���Ĥ��Ȥ��Ǥ��ޤ����ɥ�����ơ�������Ȥξܺ٤ˤĤ��Ƥϡ�
�֥ɥ�����ơ�������ȡפ��Ȥ��Ƥ���������
.SS "�ѥå����������ȥե�����"
�ƥѥå������ϡ��ȼ��Υɥ�����ơ�������Ȥ�
���Ĥ��Ȥ��Ǥ����֥������ץե�������ݻ����ޤ���
.B javadoc
�ġ���ϡ���������ѥå�����������ڡ����ˤ��Υ����Ȥ�ޡ������ޤ���
�̾���Υ����Ȥˤϡ��ѥå��������Τ�Ŭ�Ѥ����
�ɥ�����Ȥ�ޤ�ޤ���
.LP
�ѥå����������ȥե������������硢�����Ȥγ�Ǽ��Ȥ��ơ����� 2 �ĤΥե�����Τ����줫����Ǥ��ޤ���
.LP
.RS 3
.TP 2
o
\f2package\-info.java\fP \- �ѥå����������ѥå�������ᡢ�ѥå����������ȡ������ Javadoc �������Ǽ�Ǥ��ޤ������Υե������ JDK 5.0 ��Ƴ����줿��ΤǤ��ꡢpackage.html ����侩����Ƥ��ޤ���
.TP 2
o
\f2package.html\fP \- ��Ǽ�Ǥ���Τϥѥå����������Ȥ� Javadoc ���������Ǥ����ѥå��������ϳ�Ǽ�Ǥ��ޤ���
.RE
.LP
.LP
�ƥѥå������ϡ�ñ��� \f2package.html\fP �ե����롢ñ��� \f2package\-info.java\fP �ե�����Τ����줫��Ĥ��Ȥ��Ǥ��ޤ�����ξ���Ĥ��ȤϤǤ��ޤ����Τɤ��餫�Υե������ \f2.java\fP �ե�����ȤȤ�ˡ��������ĥ��Τ��Υѥå������Υǥ��쥯�ȥ�������֤��Ƥ���������
.LP
.LP
\f4package\-info.java\fP ���Υե�����ˤϡ����ι�¤�Υѥå����������Ȥ��Ǽ�Ǥ��ޤ��������Ȥϥѥå���������������֤��ޤ���
.LP
.LP
File: \f2java/applet/package\-info.java\fP
.LP
.ft 3
.nf
/**
* 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;
.fi
.ft 1
.LP
�����ȶ�ڤ�ʸ���� \f2/**\fP �� \f2*/\fP �ϵ��Ҥ���ɬ�פ�����ޤ�������ֹԤι�Ƭ�Υ������ꥹ���Ͼ�ά���Ƥ⤫�ޤ��ޤ���
.LP
.LP
\f4package.html\fP \- ���Υե�����ˤϡ����ι�¤�Υѥå����������Ȥ��Ǽ�Ǥ��ޤ��������Ȥ� \f2<body>\fP ���������֤��ޤ���
.LP
.LP
File: \f2java/applet/package.html\fP
.LP
.LP
.ft 3
.nf
<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>
.fi
.ft 1
.LP
.LP
�����ñ�ʤ��̾�� HTML �ե�����Ǥ��ꡢ�ѥå���������ޤ�Ǥ��ʤ������դ��Ƥ����������ѥå����������ȥե���������Ƥϡ��ۤ��Τ��٤ƤΥ����Ȥ�Ʊ�ͤ� HTML �ǵ��Ҥ���Ƥ��ޤ������������ۤ��Υ����ȤȰۤʤ���� 1 �Ĥ�������ޤ�������ϡ����Υɥ�����ơ�������Ȥˤϡ������ȶ�ڤ�ʸ���Ǥ��� \f2/**\fP �� \f2*/\fP������ӹ�Ƭ�Υ������ꥹ����ޤ�ƤϤʤ�ʤ����Ȥ������ȤǤ��������Ȥ���ϡ��ǽ��ʸ��ѥå������γ��פȤ���\f2<body>\fP �Ⱥǽ��ʸ�δ֤˥����ȥ�䤽��¾�Υƥ����Ȥ�ޤ�ʤ��褦�ˤ��ޤ����ѥå�����������ޤ�뤳�ȤϤǤ��ޤ������ۤ��Υɥ�����ơ�������Ȥ�Ʊ�͡����ƤΥ֥�å����������Τ��Ȥ��֤��ʤ���Фʤ�ޤ��ѥå����������ȥե������ \f2@see\fP �������ɲä�����ϡ����������̾������Ѥ���ɬ�פ�����ޤ����ܺ٤ϡ�
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#packagecomments
��
.na
��\f2example of \fP\f2package.html\fP�פȤ��Ƥ���������
.LP
.LP
\f3�ѥå����������ȥե�����ν��\fP \- Javadoc �ġ���ϡ��¹Ի��˥ѥå����������ȥե������ưŪ�˸����������Υե�����Ĥ���ȼ��ν����Ԥ��ޤ���
.LP
.RS 3
.TP 2
o
����Ǥ���褦�˥����Ȥԡ����� (\f2package.html\fP �ξ��Ǥ���С�\f2<body>\fP �� \f2</body>\fP HTML �����δ֤ˤ������Ƥ٤ƥ��ԡ����롣\f2<head>\fP ��ޤᡢ������ \f2<title>\fP �䥽�����ե�����������Ҥʤɤξ�������֤��뤳�Ȥ�Ǥ��뤬��������Υɥ�����ơ������ˤϤ����ϰ��ɽ������ʤ�)
.TP 2
o
�ѥå���������������С����٤ƽ������
.TP 2
o
���������ѥå������γ��ץڡ����κǸ�ˡ���������ƥ����Ȥ������� (��: �ѥå������γ���)
.TP 2
o
�ѥå������γ��ץڡ������Ƭ�ˡ��ѥå����������Ȥκǽ��ʸ�ԡ����롣����ˡ����ץڡ����Υѥå������ꥹ�Ȥˡ��ѥå�����̾�ȥѥå����������Ȥκǽ��ʸ���ɲä��� (��: ���פ�����)��ʸ�����ϡ����饹����Фμ����κǽ��ʸ������Ʊ����§�ˤ�ä�Ƚ�Ǥ����
.RE
.LP
.SS "���ץ����ȥե�����"
�ɥ�����Ȳ�����ƥ��ץꥱ�������ޤ��ϥѥå������Υ��åȤϡ�
�ȼ��γ��ץɥ�����ơ�������Ȥ�Ĥ��Ȥ��Ǥ��������
�֥������ץե�������ݻ�����ޤ���
.B javadoc
�ġ���ϡ��������복�ץڡ����ˤ��Υ����Ȥ�ޡ������ޤ����̾����
�����Ȥˤϡ����ץꥱ�������ޤ��ϥѥå������Υ��å���Τ�
��ƤϤޤ�ɥ�����Ȥ�ޤ�ޤ���
.LP
���ץ����ȥե������������硢�ե�����˹�����̾�����դ��ơ�
�����ʾ����֤����Ȥ��Ǥ��ޤ������̾�ϥե�����̾��
.B overview.html
�ˤ��ơ��������ĥ�ΰ��־�γ��ؤ��֤��ޤ���
���Ȥ��С�
.B java.applet
�ѥå������Υ������ե����뤬
.B /home/user/src/java/applet
�ǥ��쥯�ȥ�˴ޤޤ�Ƥ���Ȥ���ȡ�
.BR /home/user/src/overview.html
�˳��ץ����ȥե����������뤳�Ȥ��Ǥ��ޤ���
.LP
�ۤʤ�ѥå������Υ��åȤ��Ф��� javadoc ��ʣ���¹Ԥ�����ϡ�Ʊ�� 1 �ĤΥ������ե�����Υ��åȤ��Ф���ʣ��γ��ץ����ȥե��������Ǥ��ޤ���
���Ȥ��С�����ɥ�����ơ�������Ѥ� \-private ����ꤷ�� javadoc �� 1 ��¹Ԥ������ȡ������ɥ�����ơ�������Ѥˤ��Υ��ץ�������ꤷ�ʤ��Ǻ��ټ¹Ԥ��뤳�Ȥ��Ǥ��ޤ������ξ�硢�Ƴ��ץ����ȥե������ 1 ʸ�ܤǡ����Υɥ�����ơ���������Ѥޤ��������ѤȤ��Ƶ��ҤǤ��ޤ���
.LP
���ץ����ȥե���������Ƥϡ����˽Ҥ٤��ѥå����������ȥե������
Ʊ�͡�HTML �ǵ��Ҥ��줿 1 �Ĥ��礭�ʥɥ������
�����ȤǤ����ܺ٤ϡ����Ҥ����Ȥ��Ƥ��������������֤���
�ʤ�ޤ��������Υ����Ȥ���ϡ��ǽ��ʸ�ץꥱ�������
�ޤ��ϥѥå������Υ��åȤ�����ˤ���
.B <body>
�Ⱥǽ��ʸ�δ֤˥����ȥ�ޤ��Ϥ���¾�Υƥ����Ȥ�ޤ�ƤϤʤ�ޤ���
���ץ�����ޤ�뤳�Ȥ��Ǥ��ޤ����ɤΥɥ�����ơ�������Ȥ�
�Ĥ��Ƥ⡢{\f3@link\f1}
�ʳ��Υ����ϡ�����Τ��Ȥ��֤�ɬ�פ�����ޤ���
.B @see
�������ɲä�����ϡ����������̾������Ѥ���ɬ�פ�����ޤ���
.LP
.BR javadoc
�ġ���μ¹Ի��ˡ�
.B \-overview
���ץ�����ȤäƳ��ץ����ȥե�����̾����ꤷ�ޤ����ե�����ϡ�
�ѥå����������ȥե������Ʊ���褦�˽������ޤ���
.TP 2
\(bu
.B <body>
������
.B </body>
�����Ȥδ֤ˤ��뤹�٤Ƥ����Ƥ����Τ���˥��ԡ�����
.TP 2
\(bu
¸�ߤ��복�ץ�����������
.TP 2
\(bu
���פ�����ʤɤ� Javadoc ���������복�ץڡ����κǸ�ˡ�
������줿�ƥ����Ȥ�������
.TP 2
\(bu
���ץڡ������Ƭ�ˡ����ץ����Ȥκǽ��ʸ�ԡ�����
.SS "����¾�ν������ʤ��ե�����"
�������ˤϡ�
.B javadoc
�ġ���������Υǥ��쥯�ȥ�˥��ԡ����롢����¾��Ǥ�դΥե������
�ޤ�뤳�Ȥ��Ǥ��ޤ������̤ˡ����Τ褦�ʥե�����ˤϡ�
����ץ�Υ���ե��å��ե����롢Java ������
(\f3.java\f1) ����ӥ��饹 (\f3.class\f1) �ե����롢���Ƥ�
�̾�� Java ������
�ե�����Υɥ�����ơ�������Ȥαƶ�����ʤ�
��Ω���� HTML �ե�����ʤɤ�����ޤ���
.LP
�������ʤ��ե������ޤ��ˤϡ������Υե������
.BR doc-files
�Ȥ����ǥ��쥯�ȥ���֤��ޤ������Υǥ��쥯�ȥ�ϡ�Ǥ�դΥѥå�����
�ǥ��쥯�ȥ�β��˺��Ǥ��ޤ����ѥå��������Ȥˤ��Τ褦�ʥ���
�ǥ��쥯�ȥ�� 1 �Ļ��Ĥ��Ȥ��Ǥ��ޤ������Υ��֥ǥ��쥯�ȥ�ˤϡ�
�����������ץ륳���ɡ��������ե����롢
.B .class
�ե����롢���ץ�åȡ������ HTML �ե���������뤳�Ȥ��Ǥ��ޤ���
���Ȥ��С��ܥ���β�
.B button.gif
��
.B java.awt.Button
���饹�ɥ�����Ȥ˴ޤ�����ϡ����Υե������
.B /home/user/src/java/awt/doc-files/
�ǥ��쥯�ȥ���֤��ޤ���
.BR doc-files
�ǥ��쥯�ȥ��
.B /home/user/src/java/doc-files
���֤����ȤϤǤ��ޤ�����ϡ�
.B java
�ϥѥå������ǤϤʤ������Υǥ��쥯�ȥꤽ�Τ�Τ˥������ե����뤬
��äƤ��ʤ�����Ǥ���
.LP
�����ν������ʤ��ե�����ؤΥ��
���٤����Ū�˵��Ҥ���ɬ�פ�����ޤ�������ϡ�
.B javadoc
�ġ��뤬�ե�������ˡ�ñ�˥ǥ��쥯�ȥ�Ȥ�������ʪ������
���ԡ�������������Ǥ������Ȥ��С�
.B Button.java
�ɥ�����ơ����������Υ�ϡ����Τ褦�ˤʤ�ޤ���
.LP
.ft 3
.nf
/**
* This button looks like this:
* <img src="doc-files/Button.gif">
*/
.fi
.ft 1
.SH "�ƥ��ȥե����뤪��ӥƥ�ץ졼�ȥե�����"
����γ�ȯ�Ԥ��顢�ƥ��ȥե����뤪��ӥƥ�ץ졼�ȥե������
�б����륽�����ե�����ζ�Υ������ĥ����¸�������Ȥ�����˾������ޤ�����
�Ĥޤꡢ�����Υ������ե������Ʊ���ǥ��쥯�ȥ�ޤ��ϥ��֥ǥ��쥯�ȥ��
��¸�������Ȥ������ȤǤ���
.LP
���̤Υ������ե�����̾�����Ū���Ϥ���
.B Javadoc
�ġ����¹Ԥ�����ϡ�
�ƥ��ȥե����뤪��ӥƥ�ץ졼�ȥե������տ�Ū�˽������ơ�
�������ʤ��褦�ˤ��뤳�Ȥ��Ǥ��ޤ������������ѥå�����̾�ޤ���
�磻��ɥ����ɤ��Ϥ����ϡ��ʲ��Υ롼��˽��äơ������Υƥ��ȥե�����
����ӥƥ�ץ졼�ȥե����뤬
�������ʤ��褦�ˤ���ɬ�פ�����ޤ���
.LP
�ƥ��ȥե�����ȥƥ�ץ졼�ȥե�����ΰ㤤�ϡ�
�ƥ��ȥե�����ϡ�����ǥ���ѥ����ǽ�ʥ������ե�����Ǥ���Τ��Ф��ơ�
�ƥ�ץ졼�ȥե�����ϡ������ǤϤʤ��Ȥ�����Ǥ�����������
�ƥ�ץ졼�ȥե�������.java�פǽ���뤳�Ȥ��Ǥ��ޤ���
.TP
�ƥ��ȥե����� \-
��ȯ�Ԥ�¿���ϡ�����ѥå������Υ���ѥ����ǽ�Ǽ¹Բ�ǽ��
�ƥ��ȥե�����Υѥå������Υ������ե������Ʊ��
�ǥ��쥯�ȥ�����֤������ȹͤ��Ƥ��ޤ���
�������ƥ��ȥե�����ϡ�̾���ʤ��ѥå������ʤɡ�
�������ե�����ѥå������Ȥ��̤Υѥå�������°���������Ȥ�
�ͤ��Ƥ��ޤ� (���Τ��ᡢ�ƥ��ȥե�����ˤ� package ���ơ��ȥ��Ȥ��ʤ�����
�ޤ��ϥ������Ȥ��̤� package ���ơ��ȥ��Ȥ�����ޤ�)��
���Τ褦�ʾ����Ǥϡ����ޥ�ɹԤǻ��ꤵ��Ƥ��륽�����Υѥå�����̾����ꤷ��
���Υ��������ɥ�����Ȳ�����Ƥ���Ȥ��ˡ�
�ƥ��ȥե�����Ϸٹ�ޤ��ϥ��顼����������ޤ���
���Τ褦�ʥƥ��ȥե�����ϥ��֥ǥ��쥯�ȥ�����֤���ɬ�פ�����ޤ���
���Ȥ��Х������ե�����Υƥ��ȥե������
.B com.package1
���ɲä�����ϡ������Υƥ��ȥե�����ϥ��եޤޤ�뤿��
�ѥå�����̾�Ȥ��Ƥ�̵���ˤʤ�
���֥ǥ��쥯�ȥ�����֤��ޤ���
.LP
.RS 5
com/package1/test-files/
.RE
.LP
��������ȡ�
.B Javadoc
�ġ���ǤϷٹ�ʤ���
test �ǥ��쥯�ȥ���åפ��ޤ���
.LP
�ƥ��ȥե������ doc �����Ȥ��ޤޤ���硢
���Τ褦�˥磻��ɥ����ɤ�ޤ�ƥ��ȥ������ե�����̾���Ϥ���
�ƥ��ȥե�����Υɥ�����Ȥ������褦�ˡ�
.B Javadoc
�ġ�����̸Ĥ˼¹ԤǤ���褦�����Ǥ��ޤ���
\f2com/package1/test\-files/*.java\fP.
.TP
�������ե�����Υƥ�ץ졼��\-
�ƥ�ץ졼�ȥե������̾���ϡ�.java�פǽ���뤳�Ȥ⤢��ޤ�����
�ƥ�ץ졼�ȥե�����ϥ���ѥ���Ǥ��ޤ���
�������ǥ��쥯�ȥ���ݻ��������������ե������
�ƥ�ץ졼�Ȥ�������ϡ�
���Υե�����̾�˥ϥ��ե� (Buffer-Template.java �ʤ�) ��
����¾������� Java ʸ������Ѥ��ޤ���
�������뤳�Ȥǡ��������ʤ��褦�ˤʤ�ޤ���
����ϡ�
.B Javadoc
�ġ��뤬�������Τϡ���.java�����������̾����
�����Υ��饹̾�Ǥ��륽�����ե��������Ǥ��뤿��Ǥ� (�ּ��̻ҡ�http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625 ����)��
.SS "���������ե�����"
�ǥե���ȤǤϡ�
.B javadoc
�ϡ�HTML �����Υɥ�����Ȥ������ɸ��ɥå���åȤ�
�Ȥ��ޤ���
���Υɥå���åȤϡ��ʲ��μ���Υե����������ޤ����ʲ���
�� HTML�֥ڡ����פϡ����줾���̤Υե�������б����ޤ���
.B javadoc
����������ե������̾���ˤϡ����饹�䥤�ե�������̾����
���ʤ��Τȡ������Ǥʤ���� (\f3package-summary.html\f1 �ʤ�)
�� 2 ���ब����ޤ�����ԤΥ��롼�פˤϡ����ԤΥ��롼�פ�̾����
�ե�����̾�����礷�ʤ��褦�ˡ��ϥ��եޤޤ�Ƥ��ޤ���
.SS "�������ƥڡ���"
.TP 2
\(bu
�ɥ�����Ȳ�����ƥ��饹�ޤ��ϳƥ��ե��������Ф���1 �ĤΥ��饹
�ڡ����ޤ��ϥ��ե������ڡ��� (\f3classname.html\f1)
.TP 2
\(bu
�ɥ�����Ȳ�����ƥѥå��������Ф���1 �ĤΥѥå�����
�ڡ��� (\f3package-summary.html\f1)��
.B javadoc
�ġ���ˤ�äơ��������ĥ�Υѥå������ǥ��쥯�ȥ����
.B package.html
�ޤ���
package\-info.java
�Ȥ����ե�������Τ��٤Ƥ� HTML �ƥ����Ȥ��ޤ����
.TP 2
\(bu
�ѥå������Υ��å���Τ��Ф��� 1 �Ĥγ���
�ڡ��� (\f3overview-summary.html\f1)������ϡ����������
�ɥ�����Ȥ��Ƭ�ڡ����ˤʤ롣
.B javadoc
�ġ���ˤ�äơ�
.B -overview
���ץ����ǻ��ꤵ�줿�ե�������Τ��٤Ƥ� HTML �ƥ����Ȥ��ޤ���롣
���Υե����뤬�������Τϡ�
.B javadoc
�� 2 �İʾ�Υѥå�����̾���Ϥ���
������Ǥ��뤳�Ȥ���դ��롣�ܺ٤ϡ��ʲ��Ρ�HTML �ե졼�����
.SS "����ȥڡ���"
.TP 2
\(bu
�ѥå������Υ��å���Τ��Ф��� 1 �ĤΥ��饹���إڡ���
(\f3overview-tree.html\f1)�������ɽ������ˤϡ��ʥӥ��������
�С��� [����] ��å����Ƥ��顢[���إĥ] ��å�����
.TP 2
\(bu
�ƥѥå��������Ф��� 1 �ĤΥ��饹����
�ڡ��� (\f3package-tree.html\f1)��
����Υѥå������ڡ��������饹�ڡ������ޤ��ϥ��ե������ڡ�����
ɽ������[���إĥ] ��å�����ȡ����Υѥå������γ��ؤ�
ɽ�������
.TP 2
\(bu
�ƥѥå��������Ф��� 1 �Ĥ� [����]
�ڡ��� (\f3package-use.html\f1)�ȡ�
�ƥ��饹����ӥ��ե��������Ф����̤� 1 �Ĥ� [����]
�ڡ���(\f3class-use/classname.html\f1)�����Υڡ����ϡ�����Υ��饹��
���ե��������ޤ��ϥѥå������Τʤ�餫����ʬ��ȤäƤ���
�ѥå����������饹����åɡ����ȥ饯��������ӥե�����ɤ�
���Ҥ��롣���饹�ޤ��ϥ��ե����� A �ˤĤ��ƹͤ���ȡ�
����[����] �ڡ����ˤϡ�A �Υ��֥��饹��A �Ȥ�������줿
�ե�����ɡ�A ���֤���åɡ�A ���Υѥ�����ĥ�å�
����ӥ��ȥ饯����ɽ������롣���Υڡ����ˤϡ��ѥå�������
���饹���ޤ��ϥ��ե������˰�ư���Ƥ��顢�ʥӥ��������С�
�� [����] ���å����뤳�Ȥˤ�äƥ��������Ǥ���
.TP 2
\(bu
��侩 API �ڡ��� (\f3deprecated-list.html\f1)���侩����ʤ�
̾�����٤Ƥΰ�����ޤޤ�Ƥ��� (��侩̾�ϡ��̾�ϲ��ɤ��줿 API ��
¸�ߤ��뤿��˻��Ѥ��侩����Ƥ��ʤ� API ��̾���ǡ������Ƥ��Ϥ����
�֤������̾��������Ƥ��롣��侩 API �ϡ�����μ���Ǥ�
��������ǽ��������)
.TP 2
\(bu
���ե�������ͥڡ��� (\f3constant-values.html\f1) ��
static �ե�����ɤ��ͤ�ɽ������롣
.TP 2
\(bu
ľ�����ڡ��� (\f3serialized-form.html\f1)��ľ��ǽ���饹
����ӳ����ǽ���饹�ξ����ѡ������γƥ��饹�ˤϡ�ľ��
�ե�����ɤ���ӥ�åɤ˴ؤ����������롣�����ξ���ϡ�API ��
�Ȥ���ȯ�ԤǤϤʤ����Ƽ���Ԥ�ɬ�פʾ���Ǥ��롣�ʥӥ��������С���
����ʤ���硢Ǥ�դ�ľ���줿���饹�˰�ư���ơ�
���饹�� [��Ϣ����] ������������ [ľ���줿����] ��å�
����Ȥ��ξ�������Ǥ���
ɸ��ɥå���åȤϡ�ľ���줿�����Υڡ�����ưŪ��������롣
�����ˤϡ�Serializable �������� public �ޤ����� public ��
���饹���Ȥ߹��ޤ�Ƥ��ꡢ����ˡ�
.B readObject
��åɡ�
.B writeObject
��åɡ�ľ���줿�ե�����ɡ�
����� @serial ������@serialField ������@serialData ���������
�ɥ�����ơ�������Ȥ��Ȥ߹��ޤ�Ƥ��롣
ľ����ǽ�� public ���饹�������ˤϡ�
���Υ��饹�ޤ��Ϥ��Υ��饹��°����ѥå������� @serial exclude ������
���ꤹ�롣ľ����ǽ�� package private ���饹��ޤ��ˤϡ�
���Υ��饹�ޤ��Ϥ��Υ��饹��°����ѥå������� @serial include ������
���ꤹ�롣 1.4 �Ǥϡ�
\-private
���ץ�������ꤻ���� javadoc ��¹Ԥ��뤳�Ȥǡ�public ���饹�����
private ���饹�˴�����ľ����������뤳�Ȥ��Ǥ��롣
.TP 2
\(bu
���� (\f3index-*.html\f1)�����٤ƤΥ��饹̾��
���ե�����̾�����ȥ饯��̾���ե������̾������ӥ�å�̾��
����ե��٥åȽ���¤٤Ƥ��롣�����ϡ�Unicode ����褦��
��ݲ�����Ƥ��ꡢ1 �ĤΥե�����Ȥ���������뤫���ޤ����Ƭ
ʸ�� (�Ѹ�ξ�� A ���� Z) ���Ȥ��̤Υե�����Ȥ�������Ǥ���
.SS "���ݡ��ȥե�����"
.TP 2
\(bu
�إ�ץڡ��� (\f3help-doc.html\f1)���ʥӥ��������С������
�嵭�Υڡ����ˤĤ��������롣
.BR \-helpfile
��Ȥäơ��ǥե���Ȥ�
�إ�ץե�������֤�������ȼ��Υ�������إ�ץե����������
���Ȥ�Ǥ���
.TP 2
\(bu
1 �Ĥ�
.B index.html
�ե����롣ɽ���� �� HTML �ե졼�������롣���Υե�����ϡ�
�ե졼���դ��κǽ�Υڡ�����ɽ��������˥��ɤ��롣���Υե�����
���Τϡ��ƥ��������Ƥ�ޤޤʤ�
.TP 2
\(bu
ʣ��Υե졼��ե����� (\f3*-frame.html\f1)���ѥå����������饹��
����ӥ��ե������ΰ����ޤࡣHTML �ե졼���ɽ������Ȥ���
�Ȥ���
.TP 2
\(bu
�ѥå������ꥹ�ȥե����� (\f3package-list\f1)��
.B \-link
���ץ�����
.B \-linkoffline
���ץ����ǻȤ��롣����ϡ�HTML �ե�����ǤϤʤ��ƥ����ȥե�����
�Τ��ᡢ��Ǥϥ��������Ǥ��ʤ�
.TP 2
\(bu
�������륷���ȥե����� (\f3stylesheet.css\f1)�����������ڡ������
ɽ�������¤�줿����ե���ȥե��ߥꡢ�ե���ȥ��������ե���Ȥ�
�������뤪������֤�椹��
.TP 2
\(bu
���ԡ���ǥ��쥯�ȥ�˥��ԡ��������ե����� (�����������ץ롢
�������ե�����ʤ�) ����äƤ��� doc �ե�����Υǥ��쥯�ȥꡣ
.B javadoc
�ġ���Ϥ��Τ褦�ʥե�����������ʤ����Ĥޤꡢ���Τ褦�ʥե��������
.B javadoc
�����Ϥ��٤�̵�뤵��롣�������ĥ��¸�ߤ��ʤ��¤ꡢ����
�ǥ��쥯�ȥ���������ʤ�
.SS "HTML �ե졼��"
.B javadoc
�ġ���ϡ����οޤ˼����褦�ˡ�2 �Ĥ� 3 �Ĥ� HTML �ե졼�������ޤ���
1 �ĤΥѥå����������ʤ���� (�ޤ��ϥѥå��������ʤ����) �ϡ��ѥå������ΰ�����ά���뤳�Ȥˤ�äƺ����ɬ�פʿ�Υե졼�������ޤ���
�������ե����� (*\f3.java\f1) �ޤ���ñ��Υѥå�����̾���Ȥ���
.B javadoc
���ޥ�ɤ��Ϥ����ϡ���¦����˥��饹�ΰ����ɽ������
�ե졼�� (C) 1 �Ĥ�����������ޤ���
.B javadoc
��ʣ��Υѥå�����̾���Ϥ����ϡ����ץڡ��� (Detail) �˲ä��ơ�
���٤ƤΥѥå������ΰ����ɽ�������� 3 �Υե졼�� (P) ��
������ޤ������γ��ץڡ����Υե�����̾��
.BR overview-summary.html
�Ǥ����������äơ����Υե����뤬�������Τϡ�2 �İʾ�Υѥå�����
̾���Ϥ���������Ǥ���[�ե졼��ʤ�] ���å����뤫��
.BR overview-summary.html
����ɽ������褦�ˤ���ȡ��ե졼����ά�Ǥ��ޤ���
.LP
HTML �ե졼��˴���Ƥ��ʤ����ϡ��ե졼��ˤϡ����������
���������ѤΡ֥ե��������פ�ɬ�פǤ��뤳�Ȥ���դ���
ɬ�פ�����ޤ����ե졼��˥ե���������Ϳ����ˤϡ����Υե졼���
����å����ޤ�������ȡ�¿���Υ֥饦���Ǥϡ����������ӥڡ�������
��ȤäƤ��Υե졼������뤷���ꡢ[����] ��˥塼
���ޥ�ɤ�ȤäƤ��Υե졼����������Ǥ���褦�ˤʤ�ޤ���
.LP
.ft 3
.nf
------------ ------------
|C| Detail | |P| Detail |
| | | | | |
| | | |-| |
| | | |C| |
| | | | | |
| | | | | |
------------ ------------
javadoc *.java javadoc java.lang java.awt
.fi
.ft 1
.LP
HTML �ե졼�बɬ�פ��ɤ����ˤ�äơ����Τɤ��餫�Υե������
���ϥڡ����Ȥ��ƥ��ɤ��ޤ���
.LP
.TP 2
\(bu
.B index.html
(�ե졼�ढ��)
.TP 2
\(bu
.B overview-summary.html
(�ե졼��ʤ�)
.SS "���������ե����빽¤"
��������륯�饹�ե����뤪��ӥ��ե������ե�����ϡ�Java ������
�ե����뤪��ӥ��饹�ե������Ʊ���ǥ��쥯�ȥ곬�ؤ�ȿ�
����ޤ������ι�¤�ϡ�1 �ĤΥ��֥ѥå������ˤĤ� 1 �ĤΥǥ��쥯�ȥ�
�ǹ�������ޤ���
.LP
���Ȥ��С�
.B java.applet.Applet
���饹���Ф�����������ɥ�����Ȥϡ�
.BR java/applet/Applet.html
�˳�Ǽ����ޤ���������Υǥ��쥯�ȥ��̾���� apidocs ����
����ȡ�java.applet �ѥå������Υե����빽¤�⤳��˽����ޤ���
���Ҥ����褦�ˡ���frame�פȤ������̾���˴ޤ�ե�����ϡ�
���٤ƺ���ޤ��Ϻ����Υե졼���ɽ������ޤ�������
�ʳ��� HTML �ե�����ϡ����٤Ʊ�¦�Υե졼���ɽ������ޤ���
.LP
��: �ǥ��쥯�ȥ�ϡ���� (bold) �Ǽ����Ƥ���ޤ���
�������ꥹ�� (*) �ϡ�
.B javadoc
�ؤΰ���ѥå�����̾�Ǥʤ��������ե�����̾ (*\f3.java\f1) ��
�Ȥ��ˡ���ά�����ե����뤪��ӥǥ��쥯�ȥ���Ƥ��ޤ����ޤ���
����������ե�����̾�ΤȤ��ˤϡ�
.B package-list
�Ϻ�����ޤ��������Ǥ���
.B doc-files
�ǥ��쥯�ȥ�ϡ��������ĥ���¸�ߤ��ʤ��¤ꡢ�������ɽ������ޤ���
.LP
.RE
.nf
\f3
.fl
.fl
\fP\f3apidocs\fP �Ǿ�̥ǥ��쥯�ȥ�
.fl
index.html HTML �ե졼�����ꤹ����ڡ���
.fl
* overview\-summary.html ���ѥå������Υꥹ�ȡ���Ƭ������ʸ������
.fl
overview\-tree.html ���ѥå������Υ��饹���ؤΥꥹ��
.fl
deprecated\-list.html ���ѥå������ο侩����ʤ� API �Υꥹ��
.fl
constant\-values.html ���ѥå������� static �ե�����ɤ��ͤΥꥹ��
.fl
serialized\-form.html ���ѥå�������ľ���줿�����Υꥹ��
.fl
* overview\-frame.html ���ѥå������Υꥹ�ȡ�����Υե졼���ɽ�������
.fl
allclasses\-frame.html ���ѥå�����������饹�Υꥹ�ȡ������Υե졼���ɽ�������
.fl
help\-doc.html �����Υڡ����ι������桼���إ�פ�ɽ������
.fl
index\-all.html \-splitindex ���ץ����ʤ��Ǻ����줿�ǥե���Ⱥ���
.fl
\f3index\-files\fP \-splitindex ���ץ�������ꤷ�ƺ����줿�ǥ��쥯�ȥ�
.fl
index\-<number>.html \-splitindex ���ץ�������ꤷ�ƺ����줿�����ե�����
.fl
package\-list �ѥå�����̾�Υꥹ�ȡ�����Ȥ��褹�뤿�����˻��Ѥ����
.fl
stylesheet.css �ե���ȡ��������֤������� HTML �������륷����
.fl
\f3java\fP �ѥå������ǥ��쥯�ȥ�
.fl
\f3applet\fP ���֥ѥå������ǥ��쥯�ȥ�
.fl
Applet.html Applet ���饹�Υڡ���
.fl
AppletContext.html AppletContext ���ե������Υڡ���
.fl
AppletStub.html AppletStub ���ե������Υڡ���
.fl
AudioClip.html AudioClip ���ե������Υڡ���
.fl
* package\-summary.html ���Υѥå������Υ��饹�Υꥹ�ȡ���Ƭ������ʸ������
.fl
* package\-frame.html ���Υѥå������Υ��饹�Υꥹ�ȡ������Υե졼���ɽ�������
.fl
* package\-tree.html ���Υѥå������Υ��饹���ؤΥꥹ��
.fl
package\-use ���Υѥå����������Ѥ���Ƥ�����Υꥹ��
.fl
\f3doc\-files\fP ������䥵��ץ�Υե����뤬��Ǽ�����ǥ��쥯�ȥ�
.fl
\f3class\-use\fP API �����Ѥ���Ƥ�����Υڡ������Ǽ����ǥ��쥯�ȥ�
.fl
Applet.html Applet ���饹����Ѥ���ڡ���
.fl
AppletContext.html AppletContext ���ե���������Ѥ���ڡ���
.fl
AppletStub.html AppletStub ���ե���������Ѥ���ڡ���
.fl
AudioClip.html AudioClip ���ե���������Ѥ���ڡ���
.fl
\f3src\-html\fP �����������ɥǥ��쥯�ȥ�
.fl
\f3java\fP �ѥå������ǥ��쥯�ȥ�
.fl
\f3applet\fP ���֥ѥå������ǥ��쥯�ȥ�
.fl
Applet.html Applet �����������ɤΥڡ���
.fl
AppletContext.html AppletContext �����������ɤΥڡ���
.fl
AppletStub.html AppletStub �����������ɤΥڡ���
.fl
AudioClip.html AudioClip �����������ɤΥڡ���
.fl
.fi
.LP
.SS "��������� API ��"
javadoc �ġ���ϡ��ƥ��饹�����ե��������ե�����ɡ����ȥ饯����
����ӥ�åɤ����ν����������ޤ���
������ϡ����� API ���ܤ���Ǥ������Ȥ��С�
�֡��뷿���饹����ϼ��Τ褦�ˤʤ�ޤ���
.LP
.LP
\f2public final class Boolean\fP
.br
\f2extends Object\fP
.br
\f2implements Serializable\fP
.LP
.LP
Boolean.valueOf ��åɤ���ϼ��Τ褦�ˤʤ�ޤ���
.LP
.LP
\f2public static Boolean valueOf(String s)\fP
.LP
.LP
javadoc �ġ���Ͻ�����
.BR public
��
.BR protected
��
.BR private
��
.BR abstract
��
.BR final
��
.BR static
��
.BR transient
��
�����
.BR volatile
��Ȥ߹��ळ�Ȥ��Ǥ��ޤ�����
.BR synchronized
��
.BR native
��Ȥ߹��ळ�Ȥ��Ǥ��ޤ���
.BR synchronized
��
.BR native
�����Ҥϼ���ξܺ٤ȸ��ʤ��졢API ���ͤΰ���Ȥϸ��ʤ���ޤ���
.LP
�������
.BR synchronized
�˰�¸������⡢��ʣ��Υ���åɤˤ�ä�ñ���
.BR Enumeration
���¹Ԥ��ƻ��Ѥ��ƤϤʤ�ʤ��פȤ����褦�ˡ��¹Խ���Υ��ޥ�ƥ��å�����
������������ǥɥ�����Ȳ�����٤��Ǥ����ɥ�����ȤǤϡ�
�����Υ��ޥ�ƥ��å�����ã���ˡ�������٤��ǤϤ���ޤ����̤�
����ȡ�
.BR Hashtable
�ϥ���åɤ��Ф��ư���Ǥʤ���Фʤ�ޤ����������ݡ��Ȥ���뤽��
��åɤ��٤Ƥ�Ʊ�������뤳�Ȥˤ�äƤ����¸�������������ɬ��
�Ϥʤ��Ȥ������ȤǤ����Х��åȥ�٥������Ū��Ʊ����Ȥ븢�¤�α�ݤ��ơ�
�����٤��¹�������٤��Ǥ���
.LP
.SH "�ɥ�����ơ��������"
.LP
.LP
���ꥸ�ʥ�Ρ֥ɥ�����ơ�������Ȥλ��͡פϡ��ִ�Ϣ���ܡפȤ��Ƥ���������
.LP
.SS
�����������ɤؤΥ����Ȥ���
.LP
.LP
�����������ɤ�Ǥ�դ�� (���饹�����ե���������åɡ����ȥ饯����
�ޤ��ϥե������) ����ˡ��ɥ�����ơ�������� (doc ������)
�Ҥ��뤳�Ȥ��Ǥ��ޤ��� �ƥѥå������˥ɥ�����ơ�������Ȥ�
���Ǥ�����ʸ�ϼ㴳�ۤʤ�ޤ��������פˤ�ɥ�����ơ�������Ȥ�
���Ǥ��ޤ��� �ɥ�����ơ�������Ȥϡ�Javadoc �����ȤȤ�ƤФ�ޤ���
�ɥ�����ơ�������Ȥϡ������ȤλϤޤ��ʸ����
.B /**
�ȡ������Ȥν�����ʸ����
.B */
�δ֤ˤ���ʸ���ǹ�������ޤ��� ��Ƭ�Υ������ꥹ���ϡ��ƹԤ˵��ҤǤ��ޤ����ܺ٤ϡ��ʲ��������ޤ��� Linux �Ǥϥƥ����Ȥϡ�ʣ��Ԥˤ錄�äƵ��ҤǤ��ޤ���
.LP
.RS
.ft 3
.nf
/**
* This is the typical format of a simple documentation comment
* that spans two lines.
*/
.fi
.ft 1
.RE
.LP
���Τ褦�ˡ������Ȥ� 1 �ԤˤޤȤ�뤳�Ȥ�Ǥ��ޤ���
.LP
.RS
.ft 3
.nf
/** This comment takes up only one line. */
.fi
.ft 1
.RE
.LP
�����Ȥ����� - �ɥ�����ơ�������Ȥ�ǧ�������Τϡ����饹��
���ե����������ȥ饯������åɡ��ޤ��ϥե������
��������֤��줿������Ǥ� (���饹����åɡ�����ӥե�����ɤ�
���)����åɤ����Τ��֤��줿�ɥ������
�����Ȥ�̵�뤵��ޤ���
.B javadoc
�ġ���ϡ���ʸ���Ȥ� 1 �ĤΥɥ�����ơ�������Ȥ�����
ǧ�����ޤ���
.LP
�褯ȯ������ְ㤤�ϡ����פ�ʸ�饹�����Ȥȥ��饹���δ֤�
���Ƥ��ޤ����ȤǤ���
.B javadoc
�ϥ��饹�����Ȥ�̵�뤹�뤿�ᡢ��դ��Ƥ���������
.LP
.RS
.ft 3
.nf
/**
* This is the class comment for the class Whatever.
*/
import com.sun; // MISTAKE - Important not to put statements here
public class Whatever {
}
.fi
.ft 1
.RE
.LP
�����Ȥ����Τ��Ȥ˥�����³�� - �����Ȥγ��϶�ڤ�ʸ���Ǥ���
.B /**
�Τ��Ȥ��饿�����������ޤǤ�����ˤʤ�ޤ��� �������������ϡ�
��Ƭʸ����
.B @
�Ǥ���Ԥ���Ϥޤ�ޤ� (�Ԥ��Ƭ�Υ������ꥹ������Ӷ���ʸ��
�Ͻ���)�� ����Ҥ����������Ȥ����Υ����Ҥ��뤳�Ȥ�Ǥ��ޤ���
����ϡ��������������ʹߤ�³���뤳�ȤϤǤ��ޤ���
�����ΰ����ʣ��ιԤˤޤ����äƵ��ҤǤ��ޤ��� �����ο��
���¤Ϥ���ޤ������ҤǤ��륿���ȡ�1 �����ҤǤ��ʤ�
����������ޤ��� �������
.B @see
���饿����������Ϥޤ�ޤ���
.LP
.nf
\f3
.fl
/**
.fl
* This sentence would hold the main description for this doc comment.
.fl
* @see java.lang.Object
.fl
*/
.fl
\fP
.fi
.LP
.LP
ɸ�ॿ���ȥ���饤��: �����ϡ�javadoc �ġ��뤬����Ǥ��롢
doc ������������̤ʥ�����ɤǤ���javadoc �ġ���ˤϡ�@tag �Ȥ��Ƹ����
ɸ�ॿ���ȡ��������
.B {\f3@tag\f1}
�Ȥ��Ƹ���륤��饤��������ޤ������
�����뤿��ˤϡ���Ƭ�Υ������ꥹ�����������ȶ�ڤ�ʸ�� (/**) ��
�����Ƥ�ɸ�ॿ�����Ԥ��Ƭ�Ǥ���褦�����֤���ɬ�פ�����ޤ�����
�ޤꡢ�桼���ϥƥ��������Ǥ�դΰ��֤� @ ʸ������ѤǤ���
����ʸ���ϥ����λϤ�Ȥϲ�ᤵ��ޤ���@ ʸ���ǹԤ�
�Ϥ��Ƥ��줬��ᤵ��ʤ��褦�ˤ��������ϡ�HTML ����ƥ��ƥ���
@ ����Ѥ��Ƥ����������ƥ�����ɥ�����ˤϴ�Ϣ����ƥ����Ȥ�����
�ޤ�������ϡ����Υ����θ夫�鼡�Υ�����ľ���ޤǡ��ޤ��� doc ������
�κǸ�ޤǤ�Ǥ�դΥƥ����ȤǤ�����Ϣ�դ���줿�ƥ����Ȥϡ�
ʣ��Ԥˤޤ����äƵ��ҤǤ��ޤ���
����饤���ϡ����Υƥ����Ȥ���
�Ĥ������֤ˤϤɤ��Ǥ����Ǥ��������оݤȤʤ�ޤ���������ϡ�
ɸ�ॿ��
.BR @deprecated
�ȥ���饤��
.BR {@link}
���ޤޤ�Ƥ��ޤ���
.LP
.RS
.ft 3
.nf
/**
* @deprecated As of JDk 1.1, replaced by {@link #setBounds(int,int,int,int)}
*/
.fi
.ft 1
.RE
.LP
�����Ȥ� HTML �ǵ��Ҥ��ޤ����ƥ����Ȥ� HTML ��
���Ҥ��ʤ���Фʤ�ޤ���
����ϡ�HTML �Υ���ƥ��ƥ���Ȥ�ɬ�פ����뤳�ȡ�
����� HTML ��������ѤǤ��뤳��
���̣���ޤ���HTML �ϡ����Ѥ���֥饦�������ݡ��Ȥ���
Ǥ�դΥС�������Ȥ����Ȥ�
�Ǥ��ޤ���ɸ��ɥå���åȤϡ����ؼ��������륷���Ȥ�
�ե졼���ޤ�ۤ�����ʬ (�ɥ�����ơ��������
�ʳ�) �ϡ�HTML 3.2 �˽�������ɤ������褦�˵���
����Ƥ��ޤ�
(�ե졼�ॻ�å��б��Τ��ᡢ����������
�ե�����ϡ���HTML 4.0�פǻϤޤ�)��
.LP
���Ȥ��С���꾮���� (<) ����Ӥ���礭�� (>) �Ȥ���
����ϡ�
.B <
��
.BR >
�ȵ��Ҥ���ɬ�פ�����ޤ���Ʊ�ͤˡ�����ѥ���� (&) �ϡ�
.BR &
�ȵ��Ҥ���ɬ�פ�����ޤ����������
�ϡ��ܡ���ɤ� HTML ���� <b> ���ޤ���
.LP
���� doc �����Ȥ��ޤ���
.LP
.RS
.ft 3
.nf
/**
* This is a <b>doc</b> comment.
* @see java.lang.Object
*/
.fi
.ft 1
.RE
.LP
��Ƭ�Υ������ꥹ�� -
.B javadoc
�ϡ�doc �����Ȥ��Ϥ���Ȥ��ˡ��ƹԤ��Ƭ�ˤ���
ʸ���������ꥹ�� (*) �٤��˴���
�ޤ����ޤ����ǽ�Υ������ꥹ�� (*) ����ζ����
���֤��˴����ޤ���1.4 ����ϡ���Ƭ�Υ������ꥹ�����ά������硢��Ƭ�ζ���Ϻ�����ޤ�����ˤ�ꡢ<PRE> ��������� doc �����Ȥˡ�����ץ륳���ɤ�ǥ�Ȥ�Ĥ����ޤޤ�ľ�ܥڡ����Ȥ��뤳�Ȥ��Ǥ��ޤ�������ϰ���Ū�ˡ����֤���Ѱ�˥֥饦���Dz�ᤵ��ޤ�������ǥ�Ȥϡ���ڤ�ʸ�� /** �� <PRE> �����ǤϤʤ������ޡ���������Ū�Ǥ���
.LP
�ǽ��ʸ - �� doc �����Ȥκǽ��ʸ�ϡ�������Ƥ���
����ƥ��ƥ��˴ؤ���ʷ餫�Ĵ���
������ޤ�����ʸ�Ǥʤ���Фʤ�ޤ���
����ʸ�ϡ������֡��ޤ��Ϲ����
�椬³���Ƥ���ǽ�Υԥꥪ�ɡ����뤤�Ϻǽ�Υ�����ɥ�����ǽ�λ���ޤ���
.B javadoc
�ġ���ϡ�HTML �ڡ����κǽ�ˤ����������ˡ����κǽ��ʸ�ԡ����ޤ���
.LP
ʣ��ե�����ɤ�� -
.B java
�Ǥϡ�ñ���ʸ��ʣ��Υե�����ɤ���Ǥ��ޤ���
������������ʸ�Υɥ������
��������Ȥ� 1 �Ĥ����ǡ����Υ����Ȥ�
���٤ƤΥե�����ɤ˥��ԡ�����ޤ���
�������äơ��ե�����ɤ��Ȥ˸ġ���
�ɥ�����ơ�������Ȥ��դ��������ϡ�
�ƥե�����ɤ�ۤʤ�ʸ������ʤ���Фʤ�ޤ���
���Ȥ��С����Υɥ�����ơ�
������Ȥ�ñ�����Ȥ��Ƥϰ�̣�������
2 �Ĥ���Ȥ��ƽ������٤�
�Ǥ���
.LP
.RS
.ft 3
.nf
/**
* The horizontal and vertical distances of point (x,y)
*/
public int x, y; // Avoid this
.fi
.ft 1
.RE
.LP
.B javadoc
�ġ���ϡ��嵭�����ɤ��鼡�Υɥ�����Ȥ�����ޤ���
.LP
.RS
.ft 3
public int x
.fi
.ft 1
The horizontal and vertical distances of point
(x,y).
.ft 3
.nf
public int y
.fi
.ft 1
The horizontal and vertical distances of point
(x,y).
.RE
.LP
�إå���������Ѥ���Ȥ�����դ��Ƥ���������
�����ѤΥɥ�����ȥ�
���Ȥ�Ȥ��ϡ�
.B <H1>
��
.BR <H2>
�ʤɤ� HTML �إå���������Ѥ��ʤ��Ǥ�������������ϡ�
.B javadoc
�����ɥ�����Ȥ�¤������������뤿�ᡢ
�����ι�¤����������Ѥ���ȡ�
�ɥ�����Ȥν������ǽ�������뤿��Ǥ���
�����������饹��ѥå�������
�����ȤǤϡ������Υإå���������Ѥ��ƹ�¤����ؼ����Ƥ���������
.LP
��åɥ����Ȥμ�ư���ԡ�
.LP
.LP
Javadoc �ġ���ˤϡ����� 2 �Ĥξ��ˡ����饹����ӥ��ե������Υ�åɥ����Ȥԡ��ޤ��ϡַѾ��פ��뵡ǽ������ޤ������ȥ饯�����ե�����ɡ���������ҤΥ��饹�ϡ��ɥ�����ơ�������Ȥ�Ѿ����ޤ���
.LP
.RS 3
.TP 2
o
\f3��ưŪ�˥����Ȥ�Ѿ����ơ����Ĥ���ʤ��ƥ����Ȥ�����\fP \- �����ޤ��ϡ�\f2@return\fP��\f2@param\fP��\f2@throws\fP ����������åɥ����ȤǸ��Ĥ���ʤ���硢Javadoc �ġ���ϡ������С��饤�ɤ�����åɤޤ��ϼ�����Ƥ�����Ϥ��Υ�åɤ��顢�б������������ӥ��������Ȥ��Υ��르�ꥺ��˽��äƥ��ԡ����ޤ���
.LP
��̩�ˤϡ�����Υѥ����� \f2@param\fP ���������Ĥ���ʤ���硢���Υѥ����Υ����Ȥ�����̤ηѾ����ؤΥ�åɤ��饳�ԡ�����ޤ���������㳰�� \f2@throws\fP ���������Ĥ���ʤ���硢\f2�����㳰��������Ƥ�����ˤ�����\fP������ \f2@throws\fP ���������ԡ�����ޤ���
.LP
����ư��ϥС������ 1.3 �����ư��Ȥ��о�Ū�Ǥ�������ޤǤΥС������Ǥϡ������ޤ��ϥ�����¸�ߤ���С������Ȥϰ�ڷѾ�����ޤ���Ǥ�����
.TP 2
o
\f3{@inheritDoc} ������ĥ����Ȥ����Ū�˷Ѿ�����\fP \- ����饤�� \f2{@inheritDoc}\fP ��åɤμ������ޤ��� \f2@return\fP��\f2@param\fP��\f2@throws\fP ���������Ȥ������ޤ����Ѿ������б���������ޤ��ϥ��������Ȥϡ����βս�˥��ԡ�����ޤ���
.RE
.LP
.LP
�ɥ�����ơ�������Ȥ�ºݤ˥��ԡ�����Ѥ���ˤϡ��Ѿ�������åɤΥ������ե����뤬 \-sourcepath �ǻ��ꤷ���ѥ��������֤���Ƥ��뤳�Ȥ�ɬ�פˤʤ�ޤ������ޥ�ɹԤǡ����饹��ѥå��������Ϥ�ɬ�פϤ���ޤ�������ϡ����饹�� �ɥ�����Ȳ�����륯�饹�Ǥʤ���Фʤ�ʤ��ä� 1.3.x ����Υ����Ȱۤʤ�ޤ���
.LP
.LP
\f3���饹����ӥ��ե���������ηѾ�\fP \- ���饹����ӥ��ե���������Ѿ����뼡�� 3 �Ĥξ��ˡ������ȤηѾ����Ԥ��ޤ���
.LP
.RS 3
.TP 2
o
���饹�Υ�åɤ������ѡ����饹�Υ�åɤ��С��饤�ɤ��Ƥ���
.TP 2
o
���ե������Υ�åɤ������ѡ����ե������Υ�åɤ��С��饤�ɤ��Ƥ���
.TP 2
o
���饹�Υ�åɤ����ե������Υ�åɤ������Ƥ���
.RE
.LP
.LP
�ǽ�� 2 �ĤΥ����� (��åɤ������С��饤�ɤ��Ƥ�����) �Ǥϡ�
.B javadoc
�ġ���ϡ������С��饤�ɤ��Ƥ����åɤΥɥ���������
�֥����С��饤�ɡפȤ��������Ф�������������Ȥ��Ѿ�����Ƥ��뤫�ɤ����ˤ�����餺�������С��饤�ɤ���Ƥ���
��åɤؤΥ����ߤޤ���
.LP
3 ���ܤΥ����� (����Υ��饹�Υ�åɤ����ե�������
��åɤ������Ƥ�����) �Ǥϡ�
.B javadoc
�ġ���ϡ�������Ƥ���
��åɤΥɥ��������ˡ����פȤ��������Ф�������������Ȥ��Ѿ�����Ƥ��뤫�ɤ����ˤ�����餺��
�������Ƥ����åɤؤΥ����ߤޤ���
.LP
��åɤ������Ѿ�����륢�르�ꥺ�� - �����åɤ�
�ɥ�����ơ�������Ȥ����Ҥ���Ƥ��ʤ���硢�ޤ��� {@inheritDoc} �����������硢
.B javadoc
�ġ���ϡ����Τ褦�ʥ��르�ꥺ�����Ѥ���Ŭ�ڤʥ����Ȥ����ޤ���
���Υ��르�ꥺ��ϡ���äȤ�Ŭ�ڤʥɥ�����ơ�������Ȥ�
�����Ǥ���褦��߷פ���Ƥ��ꡢ�����ѡ����饹����
���ե�������ͥ�褵���褦�ˤʤäƤ��ޤ���
.TP 4
1.
ľ�ܤ˼������Ƥ��� (�ޤ��ϡ���ĥ����Ƥ���) ���ե�������
��åɤ���� implements (�ޤ��� extends) ������ɤΤ��Ȥ�
�о줹����ǡ�1 �Ĥ���Ĵ�٤롣 ���Υ�åɤˤĤ���
�ǽ�˸��Ĥ��ä��ɥ�����ơ�������Ȥ���Ѥ���
.TP 4
2.
��� 1 �ǥɥ�����ơ�������Ȥ����Ĥ���ʤ��ä����ϡ�
ľ�ܼ������Ƥ��� (�ޤ��ϡ���ĥ����Ƥ���) ���ե�������
���줾����Ф��ơ����Υ��르�ꥺ���Τ�Ƶ�Ū��Ŭ�Ѥ��� (���κݤν��ϡ���� 1 �ǥ��ե�������Ĵ�٤��Ȥ��ν���Ʊ��)
.TP 4
3.
��� 2 �ǥɥ�����ơ�������Ȥ����Ĥ���ʤ��ä����ǡ�
���Υ��饹�� Object �ʳ��Υ��饹�Ǥ��� (���ե������ǤϤʤ�) ���ϡ�
���Τ褦�˽������
.sp 1n
.nf
.ft 3
a. �����ѡ����饹�ˤ��Υ�åɤˤĤ��ƤΥɥ�����ơ�������Ȥ����Ҥ���Ƥ���С����Υ����Ȥ���Ѥ���
b. ��� 3a �ǥɥ�����ơ�������Ȥ����Ĥ���ʤ��ä����ϡ������ѡ����饹���Ф��ơ����Υ��르�ꥺ���Τ�Ŭ�Ѥ���
.ft 1
.fi
.LP
.SS "javadoc ����"
.LP
.B javadoc
�ġ���ϡ�
.B java doc
�������������ޤ줿�ü�ʥ������Ϥ��ޤ���������
�ü�� doc ������Ȥ��ȡ�
����ä������� API �ɥ�����Ȥ���
�����ɤ��鼫ưŪ������Ǥ��ޤ���
�����ϡ�ñ������ (\f3@\f1) �ǻϤޤꡢ��ʸ����ʸ����
���̤���ޤ��������Υ����ϡ�
�ʲ��˼����Ȥ���ˡ���ʸ���Ⱦ�ʸ������̤�����Ϥ���
ɬ�פ�����ޤ��������ϡ���
���Ƭ (��������Ԥ�����Ⱦ�ά��ǽ�ʥ������ꥹ���Ͻ���) ����
�Ϥ�ʤ���Фʤ�
�ޤ������塢Ʊ��̾���Υ����� 1 �Ľ�ˤޤȤ�Ƶ��Ҥ��ޤ���
���Ȥ��С�
.B @see
������ʣ�����ϡ����٤Ƥ� 1 �Ľ�ˤޤȤ�Ƶ��Ҥ��ޤ���
.LP
�����ϼ��� 2 ���ढ��ޤ���
.LP
\(bu
������ɥ���� - ����Τ��ȤΥ���������������
�֤����Ȥ��Ǥ��ޤ��� ���Υ����ϡ�@tag �Τ褦�����̤ǰϤߤޤ���
.LP
\(bu
����饤�� - �����Ȥ�����ޤ��ϥ�����ɥ������
���������Ǥ�դξ����֤����Ȥ��Ǥ��ޤ��� ����饤���ϡ�{@tag} ��
�褦�����̤ǰϤߤޤ���
.LP
����Υ�����Ƴ�����륿���ˤĤ��Ƥϡ�
.fi
http://java.sun.com/j2se/javadoc/proposed\-tags.html
��
.na
��\f2Proposed Tags\fP�פȤ��Ƥ���������
.LP
.LP
�������ͭ���ʥ����ϡ����ΤȤ���Ǥ���
.LP
.RS 3
.LP
.LP
.TS
center;
cbp-1 cbp-1
l l.
���� Ƴ����줿 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
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-42
.LP
.LP
�������ॿ���ˤĤ��Ƥϡ�\-tag ���ץ����Ȥ��Ƥ���������
.TP
.BI @author " name-text"
.B \-author
���ץ���Ȥ��Ƥ����硢
���������ɥ�����Ȥˡ����ꤵ�줿
name-text ��� Author ����ȥ���ɲä��ޤ���
1 �Ĥ� doc �����Ȥ�ʣ���
.B @author
������ޤ�뤳�Ȥ��Ǥ��ޤ���
.B @author
�������Ȥ� 1 �ġ��ޤ��ϥ������Ȥ�ʣ���̾����
����Ǥ��ޤ������Ԥξ��ϡ�
.B javadoc
�ġ���ϡ�̾����̾���δ֤˥���� (\f3,\f1) �ȥ��ڡ����������ޤ���
��Ԥξ�硢�ƥ�������Τ�
��Ϥ���뤳�Ȥʤ����������ɥ�����Ȥ˥��ԡ���������Ǥ���
���Τ��ᡢ����ްʳ�
�θ��ϻ��ͤ�̾����ڤ�ʸ����Ȥ����ϡ�1 �Ԥ�ʣ���̾������ꤷ�ޤ���
.LP
�ܺ٤ˤĤ��Ƥϡ��֥�������ѤǤ�����פ����
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@author
��
.na
\f2@author �����Υɥ������\fP�Ȥ��Ƥ���������
.LP
.TP 3
@deprecated\ deprecated\-text
.RS 3
.LP
.LP
��: JDK 5.0 ���顢@Deprecated ����Ȥä�����Υץ������Ǥ���侩�ˤǤ���褦�ˤʤ�ޤ�����
.LP
���� API �� (ư��Ϥ��뤬) ���Ѥ��٤��Ǥʤ����Ȥ�
�����Ȥ��ɲä��ޤ���
.B javadoc
�ϡ�deprecated-text ��������˰�ư���ƥ�����å��ˤ���
������˥ܡ���ɤηٹ�
�ֿ侩����ޤ��פ��ɲä��ޤ������Υ����Ϥ��٤Ƥ� doc ������ (���ס��ѥå����������饹�����ե����������ȥ饯������åɡ��ե������) ��ͭ���Ǥ���
.LP
.RS
deprecated-text �κǽ��ʸ�Ǥϡ����ʤ��Ȥ�桼���ˤɤΤ褦�ʤȤ���
���� API ���侩����ʤ���������Ӥ�������� API ������
ɬ�פ�����ޤ���
.B javadoc
�ϡ��ǽ��ʸ���������������Ⱥ����˥��ԡ����ޤ���
���Ȥ�³��ʸ�ǡ��ʤ����� API ���侩����ʤ�����
������뤳�Ȥ�Ǥ��ޤ�������� API ��
�ؤ����� {\f3@link\f1} ���� (
.B javadoc
1.2 �ʹߤξ��) ��ޤ��ɬ�פ�����ޤ���
.LP
�ܺ٤ˤĤ��Ƥϡ�
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@deprecated
��
.na
\f2@deprecated �����Υɥ������\fP�Ȥ��Ƥ���������
.LP
.TP 2
\(bu
.B javadoc
1.2 �ʹߤǤϡ�{\f3@link\f1} ��������Ѥ��Ƥ�������������ˤ�ꡢ
ɬ�פʾ��˥���饤���
���������ޤ������Ȥ��С����Τ褦�˻Ȥ��ޤ���
.LP
.RS
.ft 3
.nf
/**
* @deprecated As of JDK 1.1, replaced by
* {@link #setBounds(int,int,int,int)}
*/
.fi
.ft 1
.RE
.LP
.TP 2
\(bu
.B javadoc
1.1 �Ǥϡ���
.B @deprecated
������
.B @see
���� (����饤��ˤǤ��ʤ�) �������Τ�ɸ��η����Ǥ���
.LP
�侩����ʤ������ˤĤ��Ƥξܺ٤ϡ���
.B @deprecated
������ �Ȥ��Ƥ���������
.RE
.TP
.B {@code text}
<code>{@literal}</code> ��Ʊ��Ǥ���
.LP
�ƥ����Ȥ� HTML �ޡ������åפޤ���
���Ҥˤʤä� javadoc �����Ȥ��Ʋ�᤻���ˡ�
�ƥ����Ȥ��ɥե���Ȥ�ɽ�����ޤ���
����ˤ�� doc �����ȤǤϡ�
�ѥ����μ��� ( <Object> )������� ( 3 < 4 )��
�ޤ����� ( <- ) �ʤɤǡ�HTML ����ƥ��ƥ� ( < ����� > ) �ǤϤʤ���
�̾�λ���� (< ����� >) ����ѤǤ��ޤ���
���Ȥ��� doc �����ȤΥƥ�����
.LP
.RS 5
{@code A<B>C}
.RE
.LP
�ϡ��������줿 HTML �ڡ����ǡ����Τ褦�ˤ��Τޤ�ɽ������ޤ���
.LP
.RS 5
A<B>C
.RE
.LP
���ܤ��٤���Ȥ��ơ�<B> ������Ǥ���Ȳ�ᤵ��ޤ���
�����ɥե���Ȥˤʤ�ޤ���
.LP
�����ɥե���Ȥʤ���Ʊ����ǽ��¸�����ˤϡ�
{@literal} ����Ѥ��ޤ���
.RE
.TP
.B {@docRoot}
�������줿Ǥ�դΥڡ�������Ȥ������ɥ�����Ȥ� (�����)
�롼�ȥǥ��쥯�ȥ����Хѥ���ɽ���ޤ������Υ����ϡ����ڡ���
�ޤ��ϲ�ҤΥ��ʤɡ���������뤹�٤ƤΥڡ������黲�Ȥ���ե�����
������Ȥ��˻Ȥ��ޤ����̾�ϡ��ƥڡ����κDz������
�ڡ����˥���ޤ���
.RS
.LP
���� \f2{@docRoot}\fP �����ϡ����ޥ�ɹԤ���⡢�ɥ�����ơ�������Ȥ���Ǥ���ѤǤ��ޤ������Υ����ϡ�@return��@param��@deprecated �ʤɤ�Ǥ�դΥ����Υƥ�������ʬ��ޤࡢ���٤ƤΥɥ�����ơ�������ȡ��Ĥޤ공�ס��ѥå����������饹�����ե����������ȥ饯������åɡ�����ӥե�����ɤ�ͭ���Ǥ���
.TP 4
1.
���ޥ�ɹԤǤϡ����Τ褦�˥إå� (header)���եå� (footer)��
�ޤ��ϥڡ����κDz��� (bottom)�������ޤ���
.sp 1n
.B javadoc \-bottom '<a href="{@docRoot}/copyright.html">Copyright</a>'
.LP
�� - Makefile ����� {\f3@docRoot\f1}�Τ褦����Ѥ����硢
����� Makefile �ץ����Ǥϡ����� { } ʸ���������פ���
ɬ�פ�����ޤ��� ���Ȥ��С�Inprise MAKE �С������ 5.2 ��
Windows ��Ǽ¹Ԥ�����ϡ�{{\f3@docRoot\f1}} �Τ褦�ˡ�
���̤���Ťˤ���ɬ�פ�����ޤ�������ˡ�\-bottom �ʤɤ�
���ץ������Ф������ñ������ǤϤʤ���
��Ű�����ǰϤ�ɬ�פ�����ޤ���href
������ͤ�Ϥ�����Ͼ�ά���ޤ���
.TP
2.
doc �����Ȥˤϼ��Τ褦�˵��Ҥ��ޤ���
.sp 1n
.nf
.ft 3
/**
* See the <a href="{@docRoot}/copyright.html">Copyright</a>.
*/
.ft 1
.fi
.LP
���Υ�����ɬ�פ��ͳ�ϡ����������ɥ�����Ȥ������֥ѥå�������
Ʊ�����ؤΥǥ��쥯�ȥ�˳�Ǽ����뤿��Ǥ������Ȥ��С����Τ褦�˻��ꤷ�ޤ���
.LP
.ti +5n
.B <a href="{@docRoot}/copyright.html">
.LP
���Τ褦�˲�褵��ޤ���
.LP
.ti +5n
\f3<a href=".\|.\|/.\|.\|/copyright.html">\f1 .\|.\|. java/lang/Object.java ��
.sp 1n
�����
.sp 1n
.ti +5n
\f3<a href=".\|.\|/.\|.\|/.\|.\|/copyright.html">\f1 .\|.\|. java/lang/ref/Reference.java ��
.RE
.TP
.BI @exception " class-name description"
.B @exception
�����ϡ�
.BR @throws
��Ʊ���Ǥ���
.TP
{\f3@inheritDoc\f1}
�Ǥ�ᤤ�����ѡ����饹���鸽�ߤ� �ɥ�����ơ�������Ȥˡ��ɥ�����Ȥ�Ѿ����ޤ��� ���ε�ǽ�ˤ�ꡢ�����ȤϷѾ��ĥ�ξ�̤˰�ư������ȯ�Ԥϥ��ԡ������ƥ����Ȥ˵��Ҥ��ɲä��뤳�Ȥ��Ǥ��ޤ���
.LP
���Υ����ϡ��ɥ�����ơ�������Ȥμ��ΰ��֤ǤΤ�ͭ���Ǥ���
.RS 3
.TP 2
o
��åɤμ����֥�å��⡣���ξ�硢�����ϡ���̳��ؤΥ��饹�ޤ��ϥ��ե��������饳�ԡ������
.TP 2
o
��åɤ� @return��@param��@throws �����Υƥ����Ȱ����⡣���ξ�硢�����ƥ����Ȥϡ���̳��ؤ��б����륿�����饳�ԡ������
.RE
.LP
�Ѿ����ؤǥ����ȤĤ����ˡ�˴ؤ����Τ����ˤĤ��ơ��֥�åɥ����Ȥμ�ư���ԡ��פȤ��Ƥ������������Υ��������Ĥ���ʤ���硢�����Ȥϡ�������������롼��˱����ơ���ưŪ�˷Ѿ�����뤫�ɤ�������ޤ�ޤ���
.LP
.TP 3
{@link\ package.class#member\ label}
ɽ���ƥ����� label �ȤΥ���饤���������ޤ���\f2label\fP �ϡ����ȥ��饹�λ��ꤵ�줿�ѥå����������饹���ޤ��ϥ��Ф�̾���Υɥ�����ơ�������ؤ������ޤ������Υ����ϡ�@return��@param��@deprecated �ʤɤ�Ǥ�դΥ����Υƥ�������ʬ��ޤࡢ���٤ƤΥɥ�����ơ�������ȡ��Ĥޤ공�ס��ѥå����������饹�����ե����������ȥ饯������åɡ�����ӥե�����ɤ�ͭ���Ǥ���
.LP
���Υ����ϡ�
.B @see
�����Ȥ褯���Ƥ��ޤ����ɤ���Υ����⡢package.class#member �����
.BI label
�λ��Ȥλ����Ʊ���ǡ�ͭ���ʹ�ʸ��ޤä���Ʊ���Ǥ���
�礭�ʰ㤤�ϡ�{\f3@link\f1} �ϡ���� [��Ϣ����] ����������
�֤��ΤǤϤʤ�������饤���������Ȥ������ȤǤ���
�ޤ�������饤��ƥ����ȤΤۤ�����ʬ�ȶ��̤��뤿��ˡ�
{\f3@link\f1} �����κǽ�ȺǸ�����̤Ҥ��ޤ���
��٥����ǡ�}�פ�Ȥ�ɬ�פ�������ϡ�HTML
����ƥ��ƥ��Ρ�}�פ�Ȥ��ޤ���
.LP
1 �Ĥ�ʸ����ǻ��ѤǤ��� {@link} �����ο����¤Ϥ���ޤ���
���Υ����ϡ��ɥ�����ơ�������Ȥ�����ʬ���ޤ���
.BR @deprecated
��
.BR @return
��
.BR @param
�ʤɤ�Ǥ�դΥ����Υƥ�������ʬ�ǻȤ����Ȥ��Ǥ��ޤ���
.LP
���Ȥ��С����Υ����ȤǤϡ�
.B getComponentAt(int, int)
��åɤȤ��Ƥ��ޤ���
.LP
.ft 3
.nf
Use the {\f3@link #getComponentAt(int, int) getComponentAt\f1} method.
.fi
.ft 1
.LP
ɸ��ɥå���åȤǤϡ��嵭�Υ����Ȥ��鼡�� HTML ��
��������ޤ� (���Υ����Ȥ�Ʊ���ѥå��������̤Υ��饹�Ȥ��Ƥ�����)��
.LP
.ft 3
.nf
Use the
<a href="Component.html#getComponentAt(int, int)">getComponentAt</a>method.
.fi
.ft 1
.LP
���� HTML �ϡ�Web �ڡ�����Ǥϼ��Τ褦��ɽ������ޤ���
.LP
.ft 3
.nf
Use the getComponentAt method.
.fi
.ft 1
.LP
{\f3@link\f1} �ɥ�����Ȳ����оݤˤ��Ƥ��ʤ����饹�ˤޤ�
��ĥ����ˤϡ�
.BR \-link
���ץ�������Ѥ��ޤ���
.LP
�ܺ٤ˤĤ��Ƥϡ�
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#{@link}
��
.na
\f2{@link} �����Υɥ������\fP�Ȥ��Ƥ���������
.RE
.TP
{@linkplain package.class#member label}
��Υ�٥뤬�����ɥե���ȤǤϤʤ��ץ졼��ƥ����Ȥ�
ɽ������Ƥ�����ʳ��ϡ�
{\f3@link\f1} ��Ʊ���Ǥ��� ��٥뤬�ץ졼��ƥ����Ȥ�
���Ҥ���Ƥ����������Ǥ���������Ȥ��Ƥ���������
.LP
.ft 3
.nf
Refer to {\f3@linkplain\f1 add() the overridden method}.
.fi
.ft 1
.LP
����ϰʲ��Τ褦��ɽ������ޤ���
.LP
.ft 3
.nf
Refer to the overridden method.
.fi
.ft 1
.LP
.TP
.B {@literal text}
�ƥ����Ȥ� HTML �ޡ������åפޤ���
���Ҥˤʤä� javadoc �����Ȥ��Ʋ�᤻���ˡ�
�ƥ����Ȥ��ɥե���Ȥ�ɽ�����ޤ���
����ˤ�� doc �����ȤǤϡ�
�ѥ����μ��� ( <Object> )������� ( 3 < 4 )��
�ޤ����� ( <- ) �ʤɤǡ�HTML ����ƥ��ƥ� ( < ����� > ) �ǤϤʤ���
�̾�λ���� (< ����� >) ����ѤǤ��ޤ���
���Ȥ��� doc �����ȤΥƥ�����
.LP
.RS 5
{@literal A<B>C}
.RE
.LP
�ϡ��������줿 HTML �ڡ����ϥ֥饦���Ǽ��Τ褦�ˤ��Τޤ�ɽ������ޤ���
.LP
.RS 5
A<B>C
.RE
.LP
���ܤ��٤���Ȥ��ơ�<B> ������Ǥ���Ȳ�ᤵ�졢
�����ɥե���Ȥˤʤ�ޤ���
.LP
�����ɥե���Ȥ�Ʊ����ǽ��¸�����ˤϡ�
{@code} ����Ѥ��ޤ���
.TP
.BI @param " parameter-name description"
���ꤷ�� parameter-name �Ȼ��ꤷ�� description ����Ѥ���
�ѥ������Parameters�ץ����������ɲä��ޤ���
doc �����ȤҤ���Ȥ��ϡ�description ��ʣ��Ԥ�
³���뤳�Ȥ��Ǥ��ޤ������Υ����ϡ�
��åɡ����ȥ饯�����ޤ��ϥ��饹��
doc ��������ǤΤ�ͭ���Ǥ���
.LP
\f2parameter\-name\fP �ϡ���åɤޤ��ϥ��ȥ饯���ǤΥѥ�����̾���������饹����åɤޤ��ϥ��ȥ饯���Υ����ץѥ�����̾���ˤʤ�ޤ���
����̤ǥѥ���̾��Ϥ�ȡ����ѥ�������Ѥ��뤳�Ȥ�
���ꤷ�ޤ���
.LP
���饹�η��ѥ�������:
.nf
\f3
.fl
/**
.fl
* @param <E> Type of element stored in a list
.fl
*/
.fl
public interface List<E> extends Collection<E> {
.fl
}
.fl
\fP
.fi
.LP
��åɤη��ѥ�������:
.nf
\f3
.fl
/**
.fl
* @param string the string to be converted
.fl
* @param type the type to convert the string to
.fl
* @param <T> the type of the element
.fl
* @param <V> the value of the element
.fl
*/
.fl
<T, V extends T> V convert(String string, Class<T> type) {
.fl
}
.fl
\fP
.fi
�ܺ٤ˤĤ��Ƥϡ�
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@param
��
.na
\f2@param �����Υɥ������\fP�Ȥ��Ƥ���������
.LP
.TP 3
@return\ description
������͡ץ����������ɲä��ơ�\f2description\fP �Υƥ����Ȥ���ߤޤ������Υƥ����ȤǤϡ�����ͤη��ȡ��������ͤ��ϰϤˤĤ��Ƶ��Ҥ���ɬ�פ�����ޤ������Υ����ϡ���åɤΥɥ�����ơ�������ȤǤΤ�ͭ���Ǥ���
.LP
�ܺ٤ˤĤ��Ƥϡ�
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@return
��
.na
\f2@return �����Υɥ������\fP�Ȥ��Ƥ���������
.LP
.TP 3
@see\ reference
�ִ�Ϣ���ܡ��Ф����ɲä���\f2reference\fP ��ؤ�������ޤ��ϥƥ����ȥ���ȥ����ߤޤ���1 �ĤΥɥ�����ơ�������Ȥˤϡ�Ǥ�դο�� \f2@see\fP ���������Ǥ��ޤ������٤Ƥ� \f2@see\fP ���������Ƥϡ�Ʊ�����Ф��β��˥��롼�ײ�����ޤ���\f2@see\fP �����ˤϡ����� 3 ����η���������ޤ�����äȤ�褯�Ȥ���Τϡ�3 ���ܤη����Ǥ������Υ����ϡ����٤ƤΥɥ�����ơ�������ȡ��Ĥޤ공�ס��ѥå����������饹�����ե����������ȥ饯������åɡ�����ӥե�����ɤ�ͭ���Ǥ����ѥå����������饹���ޤ��ϥ��Ф��Ф��륤��饤����ʸ����������ˡ�ϡ�\f2{@link}\fP �Ȥ��Ƥ���������
.RS 3
.TP 3
@see "string"
string �Υƥ����ȥ���ȥ���ɲä��ޤ���
����������ޤ���string �ϡ���ҡ��ޤ���
URL �Ǥϥ��������Ǥ��ʤ�����λ����Ǥ���
.B javadoc
�ġ���ϡ��ǽ��ʸ������Ű����� (") ���ɤ�����Ĵ�٤ơ�
��� 2 �Ĥη����Ȥ��η����Ȥ��
�̤��ޤ�����������ޤ���
.LP
.RS
.ft 3
.nf
@see "The Java Programming Language"
.fi
.ft 1
.LP
����ϼ��Τ褦�ʥƥ����Ȥ�����ޤ���
.LP
.ft 3
.nf
��Ϣ����:
"The Java Programming Language"
.fi
.ft 1
.RE
.TP
\f3@see <a href="\f2URL#value\f3">\f2label\f3</a>\f1
.IR URL#value
�������줿�Ȥ���˥���ɲä��ޤ���
.I URL#value
�ϡ����� URL �ޤ������ URL �Ǥ���
.B javadoc
�ġ���ϡ��ǽ��ʸ���Ȥ��ơ����ʤ��� (\f3<\f1) ��õ�����Ȥǡ�
���Υ��¾�ξ��ȶ��̤��ޤ���
.LP
.RS
.ft 3
.nf
@see <a href="spec.html#section">Java Spec</a>
.fi
.ft 1
.LP
����ϼ��Τ褦�ʥ������ޤ���
.LP
.ft 3
.nf
��Ϣ����:
Java Spec
.fi
.ft 1
.RE
.TP
.BI @see " package.class#member label"
���Ȥ���� Java ����ǻ��ꤵ�줿̾���Υɥ�����Ȥ�ؤ���
ɽ���ƥ����� label ���
����ɲä��ޤ���label �Ͼ�ά��ǽ�Ǥ���label ���ά�������ϡ�
�������̾����
Ŭ�ڤ�û������� (��̾����ɽ���ˡ�פ�)��
ɽ���ƥ����ȤȤ��������ɽ������ޤ���-noqualifier ����Ѥ���ȡ�ɽ���ƥ����Ȥ���ѥå�����̾������Ū�˺�����ޤ�����٥�ϡ���ư���������ɽ���ƥ����ȤȤϰۤʤ�ɽ���ƥ����Ȥ���ꤹ����˻Ȥ��ޤ���
.LP
.RS
�С������ 1.2 �Ǥϡ���٥�ǤϤʤ���̾��������
HTML ����
.B <code>
�˰Ϥޤ�Ƽ�ưŪ��ɽ������ޤ����С������ 1.2.2 �ʹߤϡ�
.B <code>
�Ͼ�ˡ���٥뤬���Ѥ���Ƥ��뤫�ɤ����ˤ�����餺��
ɽ����ǽ�ʥƥ����Ȥ�Ϥߤޤ���
.TP 2
\(bu
.I package.class#member
�ˤϡ�Java �����ͭ����Ǥ�դ�̾�����Ĥޤ�ѥå�������
���饹�����ե�������
���ȥ饯������åɡ��ޤ��ϥե�����ɤ�̾������ꤷ�ޤ�
��������������̾�����
�ɥåȤϡ��ϥå���ʸ�� (#) ���֤������ޤ���
���ꤷ��̾�������ɥ�����Ȳ�����륯�饹
�ˤ����硢
.B javadoc
�ġ���ϳ������̾���ؤΥ��ưŪ�˺����ޤ���
����ȥ��饹�ؤΥ�������
�ˤϡ�
.B \-link
���ץ�����Ȥ��ޤ������Ȥ���륯�饹��°���Ƥ��ʤ�̾����
�ɥ�����Ȥ�
�Ȥ���ˤϡ��ۤ��� 2 �Ĥη�����
.B @see
������Ȥ��ޤ���1 ���ܤΰ���ˤĤ��Ƥϡ���̾���λ���� ��
�ܤ���������ޤ���
.TP 2
\(bu
.I label
�Ͼ�ά��ǽ�ʥƥ����Ȥǡ�
��Υ�٥�Ȥ���ɽ������ޤ���label �ˤ϶�����
��뤳�Ȥ��Ǥ��ޤ���label ���ά�������ϡ�
.I package.class.member
�������ߤΥ��饹����ӥѥå������˱�����
Ŭ�ڤ�û�������ɽ������ޤ�����̾����ɽ���ˡ�פȤ��Ƥ���������
.TP 2
\(bu
����ʸ����
.I package.class#member
��
.IR label
�δ֤ζ�ڤ�ʸ���Ǥ��������ζ���ʸ���ϡ�
��٥�γ��Ϥ��̣���ʤ����ᡢ
��åɤΥѥ����֤Υǥ�ߥ��Ȥ��ƻȤ����Ȥ��Ǥ��ޤ���
.LP
��-������Ǥϡ�Character ���饹��
.B @see
������ String ���饹�� equals ��åɤȤ��Ƥ��ޤ���
�����ˤϡ�̾�� \f3String#equals(Object)\f1 �ȥ�٥� \f3equals\f1 ��
ξ��ΰ���ޤޤ�Ƥ��ޤ���
.LP
.ft 3
.nf
/**
* @see String#equals(Object) equals
*/
.fi
.ft 1
.LP
ɸ��ɥå���åȤϡ����Τ褦�� HTML ������ޤ���
.LP
.ft 3
.nf
<dl>
<dt><b>��Ϣ����:</b>
<dd><a href="../../java/lang/String#equals(java.lang.Object)"><code>equals</code></a>
</dl>
.fi
.ft 1
.LP
����ϡ��֥饦���Ǥϼ��Τ褦��ɽ�����졢
��٥뤬��ƥ����Ȥˤʤ�ޤ���
.LP
.ft 3
.nf
��Ϣ����:
equals
.fi
.ft 1
.LP
.B ̾���λ���:
����
.I package.class#member
��̾���ϡ�
.BR java.lang.String#toUpperCase()
�Τ褦�˴������ꤹ�뤳�Ȥ⡢
.B String#toUpperCase()
��
.BR #toUpperCase()
�ʤɤΤ褦�˴������ꤷ�ʤ����Ȥ��ǽ�Ǥ���
�������ꤷ�ʤ���硢
.B javadoc
�ġ���ϡ��̾�� Java ����ѥ���θ������Ǹ�����Ԥ��ޤ���
�ܺ٤ϡ��ʲ��Ρ�
.BR @see
�θ������פȤ��Ƥ������������ꤹ��̾���Ǥϡ�
��åɤ�ʣ��ΰ���η��δ֤ʤɡ�
�����˶����ޤ�뤳�Ȥ��Ǥ��ޤ���
.LP
û����ʬ����̾����ꤹ�뤳�Ȥ����ϡ���Ϥ���
ʸ������뤳�Ȥȡ������������ɤ�
�ɤߤ䤹���ʤ뤳�ȤǤ����ʲ���ɽ�˼����Τϡ����ޤ��ޤ�
������̾���Ǥ���Class �ˤ�
���饹�����ե�������Type �ˤϥ��饹�����ե�������
���ޤ��ϴ��ܥǡ�������
method �ˤϥ�åɤޤ��ϥ��ȥ饯�������Ǥ��ޤ���
.LP
.LP
.TS
box;
lp-1.
@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,...)
_
T{
���ߤΡ��ޤ��ϥ���ݡ��Ȥ��줿�ѥå��������̤Υ��饹�Ȥ���
T}
@see Class#field
@see Class#method(Type, Type,...)
@see Class#method(Type argname, Type argname,...)
@see Class#constructor(Type, Type,...)
T{
@see Class#constructor(Type argname, Type argname,...)
T}
@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,...)
T{
@see package.Class#constructor(Type argname, Type argname,...)
T}
@see package.Class.NestedClass
@see package.Class
@see package
.TE
.LP
���ɽ���Ф������ʲ��˼����ޤ���
.LP
.TP 2
\(bu
���饹�ޤ��ϥѥå�������ʤ����ǽ�η����Υ��åȤǤϡ�
.B javadoc
�ġ���ϸ��ߤΥ��饹���ؤ����Ǹ�����Ԥ��ޤ���
.B javadoc
�ġ���ϡ����ߤΥ��饹�����ե������Υ��С������ѡ����饹��
�����ѡ����ե������� 1 �ġ��ޤ���
�ƥ��饹�����ե������� 1 �� (������� 1 �� 3) �����ޤ���
���ߤΥѥå������Τۤ�����ʬ��ۤ��Υѥå����� (������� 4 �� 5) ��
�������ޤ���
.TP 2
\(bu
��åɤޤ��ϥ��ȥ饯������getValue �Τ褦��
��̤��դ�����̾���Ȥ�����Ϥ��졢
����Ʊ��̾���Υե�����ɤ��ʤ����ϡ�
.B javadoc
�ġ������Τ˥������ޤ�������̤Ȱ�����ɲä���褦��
¥���ٹ��å����������
���ޤ������Υ�åɤ��С����ɤ�����硢
.B javadoc
�ġ���ϡ����ꤵ�줿��åɤǤϤʤ��������Ǹ��Ĥ��ä�
�ǽ�Υ�åɤ˥���ޤ���
.TP 2
\(bu
���Ҥ�����饹�ϡ��ɤη����ξ��Ǥ⡢ñ��
.BR inner
�Ȥ������ǤϤʤ���
.BR outer.inner
�Ȥ������ǻ��ꤷ�ʤ���Фʤ�ޤ���
.TP 2
\(bu
���Ǥ˽Ҥ٤��Ȥ��ꡢ���饹�ȥ��Ф��ڤ�Τˡ��ɥå� (\f3.\f1) �ǤϤʤ�
�ϥå���ʸ�� (\f3#\f1) ��
�Ȥ��Ƥ��뤳�Ȥ���դ��Ƥ����������ɥåȤϡ����饹��
���ҤΥ��饹���ѥå������������
���֥ѥå��������ڤ�Τˤ�Ȥ��ޤ���
��������
.B javadoc
�ġ���Ǥϰ��̤˵����ϰϤ�������
�����ޤ������ʤ���С��ɥåȤǤ�������Ϥ���ޤ���
���ξ��Ǥ�ٹ��ɽ������ޤ���
.LP
.B @see �����:
.B javadoc
�ϡ��������ե����� (\f3.java\f1)���ѥå�����
�ե����� (\f3package.html\f1 �� \f3package\-info.java\f1)���ޤ���
���ץե����� (\f3overview.html\f1) ��ǻȤ���
.B @see
�����������ޤ���
���Ȥ� 2 �ĤΥե�����Ǥϡ�
.BR @see
��Ȥäƻ��ꤹ��̾�������������ɬ�פ�����ޤ���
�������ե�����Ǥϡ���������̾
����ʬ����̾�Τɤ������ꤹ�뤳�Ȥ�Ǥ��ޤ���
.LP
.B javadoc
�ġ��뤬��������������Ƥ��ʤ�
.B .java
�ե������
.B @see
�����Ĥ�����硢���ꤵ�줿̾���� Java ����ѥ����
Ʊ�����Ǹ������ޤ�����������
.B javadoc
�ġ���ϡ������̾�����֤Τ����ޤ����ϸ��Ф��ޤ�����ϡ�
.B javadoc
�ġ��뤬�������������ɤˤ����Υ��顼��¸�ߤ��Ƥ��ʤ����Ȥ�
����Ȥ���ư��뤿��Ǥ���
�������ϡ���Java Language Specification���� 2 �Ǥ��� 6 �ϡ�Names�פ�
������������Ƥ��ޤ�������Ū�ˤϡ������ϼ��ν��ǹԤ��ޤ���
.LP
.TP 4
1.
���ߤΥ��饹�ޤ��ϥ��ե�����
.PD 0
.TP 4
2.
̾����Ϥ९�饹�ȥ��ե���������äȤ�ᤤ��Τ�ǽ�˸���
.TP 4
3.
�����ѡ����饹�ȥ����ѡ����ե���������äȤ�ᤤ��Τ�ǽ�˸���
.TP 4
4.
���ߤΥѥå�����
.TP 4
5.
����ݡ��Ȥ����ѥå����������饹��
����ӥ��ե�������import ʸ�ν��˽��äƸ���
.PD
.LP
.B javadoc
�ġ���ϡ����פ���̾�������Ĥ���ޤǡ��ƥ��饹�ˤĤ���
��� 1 �� 3 ���֤��Ƹ�����³��
�ޤ����Ĥޤꡢ���ߤΥ��饹�Ȥ��Υ��饹��Ϥ�
���饹 E ���������ȡ�E �Υ����ѥ��饹��
���������Ǹ�� E ��Ϥ९�饹�����ޤ������ 4 �� 5 �Ǥϡ�
.B javadoc
�ġ���ϡ�1 �ĤΥѥå�������ǤΥ��饹�ޤ��ϥ��ե������θ�����
�ʤ�餫�η�ޤä���
���ǹԤ��櫓�ǤϤ���ޤ��� (���θ������ϥ���ѥ���˰�¸���ޤ�)��
��� 5 �Ǥϡ�
.B javadoc
�ġ���ϡ�
.BR java.lang
�����ޤ�������ϡ�
.BR java.lang
�����٤ƤΥץ����ˤ�äƼ�ưŪ�˥���ݡ��Ȥ���뤿��Ǥ���
.LP
.B javadoc
�ġ���ϡ�ɬ�����⥵�֥��饹������櫓�ǤϤʤ���Javadoc �ġ����
�¹���ˤۤ��Υѥå�����
�Υɥ�����Ȥ������������Ǥ⡢�ۤ��Υѥå�������
�����ϹԤ��ޤ���
���Ȥ��С�
.B @see
������
.B java.awt.event.KeyEvent
���饹�ˤ��äơ�
.B java.awt
�ѥå������ˤ���̾���Ȥ����硢
.B javadoc
�ϡ����Υ��饹������ݡ��Ȥ��ʤ��¤ꤽ�Υѥå����������ޤ���
.LP
.B ̾����ɽ���ˡ:
.I label
����ά���줿���ϡ�
.I package.class.member
��ɽ������ޤ����̾package.class.member �ϡ����ߤ�
���饹����ӥѥå�������
������Ŭ�ڤ�û������ޤ�����û�������פȤϡ�
.B javadoc
�ġ��뤬ɬ�Ǿ��¤�̾����ɽ������Ȥ������ȤǤ���
���Ȥ��С�String.toUpperCase() ��åɤ�Ʊ��
���饹�Υ��Фؤλ��Ȥȡ��̤Υ��饹�Υ��Фؤ�
���Ȥ�ޤ�Ǥ����硢���饹̾�ϸ�Ԥξ����ɽ������ޤ���
.LP
�ѥå�����̾��Ū�˺�����ˤϡ�\-noqualifier ����Ѥ��ޤ���
.br
.LP
.TP 4
.TS
box, center;
cbp-1 | cbp-1 | cbp-1
l | l | l .
���Ȥμ��� T{
String.toUppercase() �Ǥ���
T} ɽ��
_
T{
@see ������Ʊ�����饹��Ʊ���ѥå������Υ��ФȤ��Ƥ���
T} T{
@see String#toLowerCase()
T} T{
toLowerCase() (�ѥå���������ӥ��饹̾�Ͼ�ά)
T}
_
T{
@see �������ۤʤ륯�饹��Ʊ���ѥå������Υ��ФȤ��Ƥ���
T} T{
@see Character#toLowerCase(char)
T} T{
Character.toLowerCase(char) (�ѥå�����̾�Ͼ�ά�������饹̾��ޤ�)
T}
_
T{
@see �������ۤʤ륯�饹���ۤʤ�ѥå������Υ��ФȤ��Ƥ���
T} T{
@see java.io.File#exists()
T} T{
java.io.File.exists() (�ѥå�����̾�ȥ��饹̾��ޤ�)
T}
.TE
.LP
\f3@see ����\fP
.br
��¦�Υ����Ȥϡ�\f2@see\fP �������̤Υѥå����� (\f2java.applet.Applet\fP �ʤ�) �Υ��饹��ˤ�����ˡ�̾�����ɤΤ褦��ɽ������뤫���Ƥ��ޤ���
.nf
\f3
.fl
See also:
.fl
@see java.lang.String // String \fP\f3
.fl
@see java.lang.String The String class // The String class \fP\f3
.fl
@see String // String \fP\f3
.fl
@see String#equals(Object) // String.equals(Object) \fP\f3
.fl
@see String#equals // String.equals(java.lang.Object) \fP\f3
.fl
@see java.lang.Object#wait(long) // java.lang.Object.wait(long) \fP\f3
.fl
@see Character#MAX_RADIX // Character.MAX_RADIX \fP\f3
.fl
@see <a href="spec.html">Java Spec</a> // Java Spec \fP\f3
.fl
@see "The Java Programming Language" // "The Java Programming Language" \fP\f3
.fl
\fP
.fi
.I @see
�ɥ�����Ȳ����оݤˤ��Ƥ��ʤ����饹�ˤޤdz�ĥ����ˤϡ�
.I -link
���ץ�������Ѥ��ޤ���
.LP
�ܺ٤ˤĤ��Ƥϡ�
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@see
��
.na
\f2@see �����Υɥ������\fP�Ȥ��Ƥ���������
.RE
.TP 3
.BI @serial " field-description" | include | exclude
�ǥե���Ȥ�ľ��ǽ�ե�����ɤ� doc �����Ȥǻ��Ѥ��ޤ���
.RS
.LP
��ά��ǽ�� field-description �ϡ�
�ե�����ɤ� doc �����Ȥ��ĥ���ޤ���
�������Ǥϡ��ե�����ɤΰ�̣�����
�������ͤΥꥹ�Ȥ���ꤷ�ʤ���Фʤ�ޤ���
ɬ�פʾ��ˤϡ�ʣ��ιԤˤޤ����ä����Ҥ��뤳�Ȥ��Ǥ��ޤ���
ɸ��ɥå���åȤϡ����ξ����ľ���줿�����Υڡ������ɲä��ޤ���
.LP
���饹��ľ�������Ȥ��Ф餯���Ƥ���ľ��ǽ�ե�����ɤ饹���ɲä�����硢�����ˡ��ɲä����С��������̤���ʸ���ɲä���ɬ�פ�����ޤ���
.LP
.BR include
��
.BR exclude
����ϡ�ľ���줿�����Υڡ����˥��饹�ޤ��ϥѥå�������ޤ��٤�����
���뤤�Ϥ����ΰ������٤�������ꤷ�ޤ���
�����ϡ����Τ褦��ư��ޤ���
.LP
.TP 2
\(bu
.BR Serializable
�������� public ���饹�ޤ��� protected ���饹�ϡ�
���Υ��饹 (�ޤ��Ϥ��Υѥå�����) ��
.BR @serial
.BR exclude
�ȥޡ�������Ƥ��ʤ��¤�ޤ���ޤ���
.TP 2
\(bu
.BR Serializable
�������� private ���饹�ޤ��� package\-private ���饹�ϡ�
���Υ��饹 (�ޤ��Ϥ��Υѥå�����) ��
.BR @serial
.BR include
�ȥޡ�������Ƥ��ʤ��¤�����ޤ���
.LP
��:
.BR javax.swing
�ѥå������ϡ�(package.html �ޤ��� \f2package\-info.java\fP ���)
.BR @serial
.BR exclude
�ȥޡ�������ޤ���
public ���饹�Ǥ���
.BR java.sercurity.BasicPermission
�ϡ�
.BR @serial
.BR exclude
�ȥޡ�������ޤ���package\-private ���饹�Ǥ���
.BR java.util.PropertyPermissionCollection
�ϡ�
.BR @serial
.BR include
�ȥޡ�������ޤ���
.LP
���饹��٥�Υ���
.BR @serial
�ϡ��ѥå�������٥��
.BR @serial
���С��饤�ɤ��ޤ���
.LP
�����Υ����λ���ˡ�ˤĤ��Ƥξܺ٤Ȼ�����ϡ���Java ���֥�������ľ���͡פ��� 1.6 ��֥��饹��ľ��ǽ�ʥե�����ɤ���ӥǡ�����ʸ�פȤ��Ƥ����������ޤ���
.fi
http://java.sun.com/products/jdk/serialization/faq/#javadoc_warn_missing
��
.na
��\f2ľ�� FAQ\fP�פ⻲�Ȥ��Ƥ������������� FAQ �ˤϡ���\-private �����å�����ꤷ�ʤ��� javadoc ��¹Ԥ��Ƥ���Τ� private �ե�����ɤ� @serial ���������Ĥ���ʤ��Ȥ��� javadoc �ηٹ�ɽ�������פʤɤΰ���Ū�ʼ���ؤβ�������ܤ���Ƥ��ޤ���ľ�������ͤ˥��饹��ޤ����ˤϡ�
.fi
http://java.sun.com/j2se/javadoc/writingapispecs/serialized\-criteria.html
��
.na
��\f2Sun �λ���\fP�פ⻲�Ȥ��Ƥ���������
.LP
.RE
.TP
.BI @serialField " field-name field-type field-description"
Serializable ���饹�� serialPersistentFields ���Ф� ObjectStreamField ����ݡ��ͥ��
��ɥ�����Ȳ����ޤ����� ObjectStreamField ����ݡ��ͥ�Ȥ��Ф���
.B @serialField
������ 1 �ĻȤ�ɬ�פ�����ޤ���
.TP
.BI @serialData " data-description"
.I data-description
�ϡ�ľ���줿�����ǤΥǡ����η��Ƚ���
�������ƥ����ȤǤ��� ���Υǡ����ˤϡ�
�äˡ�writeObject ��åɤˤ�äƽ��ޤ���ά��ǽ��
�ǡ���������� Externalizable.writeExternal ��åɤˤ�ä�
���ޤ�뤹�٤ƤΥǡ��� (���쥯�饹��ޤ�) ���ޤޤ�ޤ���
.TP
.B @serialData
�����ϡ�writeObject��readObject��writeExternal������� readExternal �γƥ�åɤ�
doc �����Ȥǻ��ѤǤ��ޤ���
.LP
.TP 3
@since\ since\-text
�����ɥ�����Ȥˡ�Ƴ����줿�С��������Ф����ɲä������ꤵ�줿 \f2since\-text\fP ����ߤޤ������Υƥ����Ȥˤϡ����̤�����¤�Ϥ���ޤ����Υ����ϡ����٤ƤΥɥ�����ơ�������ȡ��Ĥޤ공�ס��ѥå����������饹�����ե����������ȥ饯������åɡ�����ӥե�����ɤ�ͭ���Ǥ������Υ����ϡ�������ѹ��ޤ��ϵ�ǽ����\f2since\-text\fP �˼����줿���եȥ����������ʹߡ�¸�ߤ��Ƥ��뤳�Ȥ��̣���ޤ�����������ޤ���
.nf
\f3
.fl
@since 1.5
.fl
\fP
.fi
Java �ץ�åȥե�����Υ����������ɤξ�硢���Υ����ϡ�Java �ץ�åȥե����� API ���ͤΥС��������ޤ��������ѹ��䵡ǽ����ե��������ɲä��줿�������Ȥϸ¤�ޤ���ʣ��� @since ��������ѤǤ���ʣ��� @author �����Τ褦�˰����ޤ����ץ������Ǥ�ʣ��� API �ǻ��Ѥ�����硢ʣ��Υ�������ѤǤ��ޤ���
.RE
.TP
.BI @throws " class-name description"
.B @throws
������
.B @exception
������Ʊ���Ǥ������������ɥ�����ơ������ˡ�
.I class-name
�����
.I description
�ƥ����Ȥ�� [�㳰] �����Ф����ɲä��ޤ���
.I class-name
�ϡ���������åɤˤ�ä�
����������ǽ���Τ����㳰��̾���Ǥ������Υ����ϡ�doc �����Ȥޤ��ϥ��ȥ饯���ǤΤ�ͭ���Ǥ������Υ��饹������
��������Ƥ��ʤ���硢
.B javadoc
�ġ���ϸ������˽��äƥ��饹��õ���ޤ���
Ʊ���ޤ��ϰۤʤ��㳰�� doc �����Ȥǡ�
ʣ��� @throws ��������ѤǤ��ޤ���
.LP
���٤ƤΥ����å��Ѥ��㳰���ɥ�����Ȳ������褦�ˤ��뤿��ˡ�
@throws ������ throws ������㳰�Ѥ�¸�ߤ��ʤ����ϡ�
@throws �����Τ���ɥ�����ȤǤ��뤫�Τ褦�ˡ�
.B Javadoc
�ġ���ˤ�ä��㳰�� HTML ���Ϥ����ʤ���
��ưŪ���ɲä���ޤ���
.LP
�����С��饤�ɤ��줿��åɤ����Ū���㳰��������Ƥ�����˸¤äơ�
�����С��饤�ɤ��줿��åɤ��饵�֥��饹��
@throws �ɥ�����Ȥ����ԡ�����ޤ���
���ե�������åɤ�������åɤ˥��ԡ���������
Ʊ�ͤǤ���{@inheritDoc} ����Ѥ��ơ��Ѿ��ɥ�����Ȥ��Ф���
����Ū�� @throws ��Ŭ�Ѥ��뤳�Ȥ��ǽ�Ǥ���
.LP
�ܺ٤�
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@exception
��
.na
\f2@throws �����Υɥ������\fP�Ȥ��Ƥ���������
.TP
.B {@value package.class#field}
{@value} ����Ū�ե�����ɤ� doc �����Ȥ�
����ʤ��ǻ��Ѥ���Ƥ����硢���������ͤ�ɽ������ޤ���
.LP
.RS 5
.nf
/**
* The value of this constant is {@value}.
*/
public static final String SCRIPT_START = "<script>"
.fi
.RE
.LP
Ǥ�դ� doc ��������ǰ���
.B package.class#field
����ǻ��Ѥ���Ƥ�����ϡ����ꤷ�������ͤ�ɽ������ޤ���
.LP
.RS 5
.nf
/**
* Evaluates the script starting with {@value #SCRIPT_START}.
*/
public String evalScript(String script) {
}
.fi
.RE
.LP
���� package.class#field �ϡ�@see �����Ʊ��η����ˤʤ�ޤ���
�����������Ф���Ū�ե�����ɤˤʤ���Фʤ�ʤ�����ۤʤ�ޤ���
.LP
���������Ǥ��ͤϡ������ե�������͡ץڡ����ˤ�ɽ������ޤ���
.TP
.BI @version " version-text"
\-version ���ץ���Ȥ��Ƥ����硢�����ɥ�����Ȥˡ֥С����������Ф����ɲä��ơ����ꤵ�줿 \f2version\-text\fP ����ߤޤ������Υ����ϡ����Υ����ɤ��ޤޤ�륽�եȥ������θ��ߤΥС�������ֹ���ݻ�����褦�˰տޤ���Ƥ��ޤ���������Ф���@since �ϡ����Υ����ɤ�Ƴ����줿�С�������ֹ���ݻ����ޤ���\f2version\-text\fP �ˤϡ����̤�����¤�Ϥ���ޤ��С����������ѤǤ������Ĵ�٤�ˤϡ��֥�������ѤǤ�����פȤ��Ƥ���������
.LP
1 �ĤΥɥ�����ơ�������Ȥ�ʣ��� \f2@version\fP ������ޤ�뤳�Ȥ��Ǥ��ޤ���ɬ�פ˱����ơ�\f2@version\fP �������Ȥ� 1 �ĤΥС�������ֹ����ꤹ�뤳�Ȥ⡢�������Ȥ�ʣ��ΥС�������ֹ����ꤹ�뤳�Ȥ�Ǥ��ޤ������Ԥξ��ϡ�Javadoc �ġ���ˤ�äơ�̾����̾���δ֤˥���� (\f2,\fP) �ȥ��ڡ������������ޤ�����Ԥξ��ϡ��ƥ�������Τ�����Ϥ���뤳�Ȥʤ��������ɥ�����Ȥˤ��Τޤޥ��ԡ�����ޤ����������äơ�����ޤǤϤʤ����Ƹ�����б�����̾����ڤ�ʸ����Ȥ�ɬ�פ�������ϡ�1 �ĤΥ�����ʣ���̾�������Ǥ��ޤ���
.LP
�ܺ٤ˤĤ��Ƥϡ�
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@version
��
.na
\f2@version �����Υɥ������\fP�Ȥ��Ƥ���������
.SS "��������ѤǤ�����"
�ʲ��Ǥϡ���������ѤǤ�����ˤĤ��������ޤ���@see��@since��@deprecated��{@link}��{@linkplain} ����� {@docroot} �Υ����ϡ����٤Ƥ� doc �����Ȥǻ��ѤǤ��ޤ���
.SS "���ץɥ�����ȥ���"
���ץ����ϡ����ץڡ����Υɥ������
������ (�̾�� \f3overview.html\f1
�Ȥ���̾���Υ������ե�������ˤ���) �ǻ��ѤǤ��륿���Ǥ���
�ۤ��Υɥ������
�����Ȥ�Ʊ�ͤˡ������Υ����ϡ�����Τ��ȤǻȤ�ɬ�פ�����ޤ���
.LP
��:�С������ 1.2 �Ǥϡ����ץɥ��������� {\f3@link\f1} ������
�Х�������ޤ����ƥ����Ȥ�Ŭ�ڤ�ɽ������ޤ�����
������ꤵ��ޤ���
���ߤΤȤ���{\f2@docRoot\f1} �����ϡ�
���ץɥ��������Ǥ�ư��ޤ���
.LP
.LP
.TS
;
cbp-1
l .
���ץ���
@see
@since
@author
@version
{@link}
{@linkplain}
{@docRoot}
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-20
.LP
.SS "�ѥå������ɥ�����ȥ���"
�ѥå����������ϡ��ѥå������Υɥ������
������ (\f3package.html\f1 �ޤ��� \f2package\-info.java\fP �Ȥ���
̾���Υ������ե������¸��) �ǻ��ѤǤ��륿���Ǥ���
�����ǻ��ѤǤ��� @serial �����ϡ�include �ޤ���
exclude �������ꤷ����Τ����Ǥ���
.LP
.LP
.TS
;
cbp-1
l .
�ѥå���������
@see
@since
@serial
@author
@version
{@link}
{@linkplain}
{@docRoot}
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-22
.LP
.SS "���饹����ӥ��ե������ɥ�����ȥ���"
���˼����Τϡ����饹�ޤ��ϥ��ե������Υɥ������
�����Ȥǻ��ѤǤ��륿���Ǥ���
�����ǻ��ѤǤ��� @serial �����ϡ�
include �ޤ��� exclude �������ꤷ����Τ����Ǥ���
.LP
.LP
.TS
;
cbp-1
l .
���饹����ӥ��ե���������
@see
@since
@deprecated
@serial
@author
@version
{@link}
{@linkplain}
{@docRoot}
.TE
.LP
���ϡ����饹�����Ȥ���Ǥ���
.LP
.RS
.ft 3
.nf
/**
* 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 {
...
}
.fi
.ft 1
.RE
.SS "�ե�����ɥɥ�����ȥ���"
���˼����Τϡ��ե�����ɤΥɥ�����ơ�������Ȥ�
���ѤǤ��륿���Ǥ���
.LP
.LP
.TS
;
cbp-1
l .
�ե�����ɥ���
@see
@since
@deprecated
@serial
@serialField
{@link}
{@linkplain}
{@docRoot}
{@value}
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-24
.LP
���ϡ��ե�����ɥ����Ȥ���Ǥ���
.LP
.RS
.ft 3
.nf
/**
* The X-coordinate of the component.
*
* @see #getLocation()
*/
int x = 1263732;
.fi
.ft 1
.RE
.SS "���ȥ饯������ӥ�åɥɥ�����ȥ���"
���ˡ����ȥ饯���ޤ��ϥ�åɤΥɥ�����ơ�����������ɽ���Ǥ��륿�����ޤ�����������@return �ϥ��ȥ饯���Ǥ�ɽ���Ǥ�����{@inheritDoc} ��
ɽ������¤�����ޤ���@serialData �����������ľ��åɤ� doc �����ȤǤΤ��ѤǤ��ޤ���
.LP
.LP
.TS
;
cbp-1
l .
��åɤ���ӥ��ȥ饯������
@see
@since
@deprecated
@param
@return
@throws and @exception
@serialData
{@link}
{@linkplain}
{@inheritDoc}
{@docRoot}
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-28
.LP
���ϥ�åɤ� doc �����Ȥ���Ǥ���
.LP
.RS
.ft 3
.nf
/**
* 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) {
...
}
.fi
.ft 1
.RE
.SH "���ץ����"
.B javadoc
�ġ���ϡ��ɥå���åȤ�Ȥäƽ��Ϥ���ꤷ�ޤ���
.B javadoc
�ġ���ϡ�
.B \-doclet
���ץ����ǥ�������ɥå���åȤ����ꤵ��Ƥ�����ʳ��ϡ�
�ǥե���Ȥ�ɸ��ɥå�
��åȤ�Ȥ��ޤ���
.B javadoc
�ġ���ˤϡ�Ǥ�դΥɥå���åȤȤȤ�˻��ѤǤ��륳�ޥ�ɹ�
���ץ������ޤ��������Υ���
�����ˤĤ��Ƥϡ���ҤΡ�javadoc �Υ��ץ����פ������ޤ���
ɸ��ɥå���åȤǤϡ���
�Τۤ��ˡ������Ĥ����ɲäΥ��ޥ�ɹԥ��ץ��������ޤ���
�����Υ��ץ�����
�Ĥ��Ƥϡ���ҤΡ�ɸ��ɥå���åȤ����륪�ץ����פ�
������ޤ����ɤΥ��ץ����
̾����ʸ���Ⱦ�ʸ������̤��ޤ������������ץ����ΰ���Ǥ�
��ʸ���Ⱦ�ʸ������
�̤���뤳�Ȥ�����ޤ���
.LP
���ץ�����ʲ��˼����ޤ���
.LP
.RS 3
.LP
.LP
.TS
center;
li l li
l li li
li l li
l li li
li l l
l l li
li l li
l l l
l li l
l l li
li l l
li l l
l l l
li l l
li l l
l l li
li l l
l l l
l l l
l li l
l li l.
-1.1 -header -private
-author -help -protected
-bootclasspath -helpfile -public
-bottom -J -quiet
-breakiterator -keywords -serialwarn
-charset -link -source
-classpath -linkoffline -sourcepath
-d -linksource -splitindex
-docencoding -locale -stylesheetfile
-docfilessubdirs -nocomment -subpackages
-doclet -nodeprecated -tag
-docletpath -nodeprecatedlist -taglet
-doctitle -nohelp -tagletpath
-encoding -noindex -title
-exclude -nonavbar -use
-excludedocfilessubdir -noqualifier -verbose
-extdirs -nosince -version
-footer -notimestamp -windowtitle
-group -notree
-overview
-package
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-123
.LP
.RE
.LP
\f2�����դ�\fP�Ǽ����줿���ץ����ϡ�Javadoc �δ��ܥ��ץ����Ǥ��ꡢJavadoc �ġ���Υե��ȥ���ɤˤ�ä����졢���٤ƤΥɥå���åȤǻ��ѤǤ��ޤ���ɸ��ɥå���åȼ��Τϡ������դ��Ǥʤ����ץ��������ޤ���
.LP
.SS "Javadoc �Υ��ץ����"
.TP
.BI \-overview " path/filename"
.B javadoc
���Ф��ơ�
.I path/filename
�ǻ��ꤵ�줿�֥������ץե����뤫��
���ץɥ�������ѤΥƥ�����
�����������ץڡ��� (\f3overview-summary.html\f1) �����֤��뤳�Ȥ�
�ؼ����ޤ���
.I path/filename
�ϡ�
.BR \-sourcepath
�ؤ���Хѥ��Ǥ���
.LP
.RS
.I filename
��
.IR path
�ˤϡ����줾��Ǥ�դ�̾���Ⱦ������Ǥ��ޤ������̾�ϡ�
.B overview.html
�Ȥ���̾�����դ��ơ��������ĥ��κǾ�̤�
�ѥå������ǥ��쥯�ȥ��ޤ�ǥ��쥯�ȥ�
�����֤��ޤ������ξ��Ǥϡ�
.B \-sourcepath
�����Υե������ؤ��Τǡ��ѥå�������
�ɥ�����Ȳ�����ݤ� path ��ɬ�פ���ޤ���
���Ȥ��С�java.lang �ѥå������Υ������ĥ��
.BR /src/classes/java/lang/
�ξ�硢���ץե������
.BR /src/classes/overview.html
�����֤Ǥ��ޤ����ֻ�����פȤ��Ƥ���������
.LP
.IR path/filename
�ǻ��ꤹ��ե�����ˤĤ��Ƥϡ�
�ֳ��ץ����ȥե�����פȤ��Ƥ���������
.LP
���ץڡ������������Τϡ�
.B javadoc
�� 2 �İʾ�Υѥå�����̾���Ϥ���������Ǥ���
�ܺ٤ϡ���HTML �ե졼���
��Ȥ��Ƥ���������
.LP
���ץڡ����Υ����ȥ�ϡ�
.B \-doctitle
�ˤ�ä���ꤵ��ޤ���
.RE
.TP
.B \-public
public �ʥ��饹�ȥ��Ф�����ɽ�����ޤ���
.TP
.B \-protected
protected ����� public �ʥ��饹�ȥ��Ф�����ɽ�����ޤ���
����ϥǥե���Ȥ�ư��Ǥ���
.TP
.B \-package
�ѥå������������ protected �� public ��
���饹�ȥ��Ф�����ɽ�����ޤ���
.TP
.B \-private
���٤ƤΥ��饹�ȥ��Ф�ɽ�����ޤ���
.TP
.B \-help
����饤��إ�פ�ɽ�����ޤ���
.B javadoc
�ȥɥå���åȤΥ��ޥ�ɹԥ��ץ����ΰ����ɽ������ޤ���
.TP
.BI \-doclet " class"
�ɥ�����Ȥ�����˻Ȥ�
�ɥå���åȤ�ư���뤿��Υ��饹�ե��������ꤷ�ޤ���
���������̾������ꤷ�Ƥ���������
�ɥå���åȤǤϡ����Ϥ����Ƥȷ����������ޤ���
.B \-doclet
���ץ���Ȥ��Ƥ��ʤ���硢
.B javadoc
��ɸ��ɥå���åȤ�Ȥäƥǥե���Ȥ� HTML ����������ޤ���
���Υ��饹�ˤϡ�
start(Root) ��åɤ��ޤޤ�Ƥ��ʤ���Фʤ�ޤ���
���ε�ư���饹�ؤΥѥ��ϡ�
.B \-docletpath
���ץ����ˤ�ä�������ޤ���
.LP
���Ȥ��С�MIF �ɥå���åȤ�ƤӽФ��ˤϡ����Τ褦�˻��ꤷ�ޤ���
.LP
.RS
.ft 3
.nf
-doclet com.sun.tools.doclets.mif.MIFDoclet
.fi
.ft 1
.LP
����Υɥå���åȤ�¹Ԥ�����������ˤĤ��Ƥϡ�
.fi
http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html#runningmifdoclet
��
.na
��\f2Running the MIF Doclet\fP�פȤ��Ƥ���������
.RE
.TP
.BI \-docletpath " classpathlist"
.B \-doclet
���ץ����ǻ��ꤵ��Ƥ���ɥå���åȥ��饹�ե����롢
����Ӥ���˰�¸���� jar �ե�����ؤΥѥ�����ꤷ�ޤ���
��ư���饹�ե����뤬 jar �ե�������ˤ����硢
��˽��äơ����� jar �ե�����ؤΥѥ�����ꤷ�ޤ���
���Хѥ����ޤ��ϸ��ߤΥǥ��쥯�ȥ꤫�����Хѥ������Ǥ��ޤ���
.IR classpathlist
�ˤϡ�ʣ��Υѥ��ޤ��� jar �ե������ޤ��
���Ȥ��Ǥ��ޤ������ξ�硢�ƥѥ��ޤ��� jar �ե������ Solaris �Ǥϥ���� (\f3:\f1)�ǡ�Windows �Ǥϥ��ߥ���� (;) �Ƕ�ڤ�ޤ���
��Ū�Υɥå���åȤγ��ϥ��饹�����Ǥ˸����ѥ���ˤ�����ϡ�
���Υ��ץ��������פǤ���
.LP
������� jar �ե�����ؤΥѥ��ˤϡ��ɥå���åȤ�
���ϥ��饹�ե����뤬�ޤޤ�Ƥ��ޤ���
jar �ե�����̾���ޤޤ�Ƥ��������դ��Ƥ���������
.nf
\f3
.fl
\-docletpath /home/user/mifdoclet/lib/mifdoclet.jar
.fl
\fP
.fi
���ϥɥå���åȤγ��ϥ��饹�ե�����Υѥ�����Ǥ���
���饹�ե�����̾����ά����Ƥ��뤳�Ȥ���դ��Ƥ���������
.nf
\f3
.fl
\-docletpath /home/user/mifdoclet/classes/com/sun/tools/doclets/mif/
.fl
\fP
.fi
����Υɥå���åȤ�¹Ԥ�����������ˤĤ��Ƥϡ�
.fi
http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html#runningmifdoclet
��
.na
��\f2Running the MIF Doclet\fP�פȤ��Ƥ���������
.RE
.LP
.TP
.B \-1.1
���ε�ǽ�ϡ�javadoc 1.4 ���������ޤ��������ؤε�ǽ��
¸�ߤ��ޤ����Υ��ץ����ϡ�javadoc 1.1 ����������
�ɥ�����Ȥγ��Ѥȵ�ǽ (���ݡ��Ȥ���ʤ��ʤä������Ҥˤʤä����饹��
�ޤ�) ��������ɥ�����Ȥ�����뤿��Τ�ΤǤ�����
���Υ��ץ����ɬ�פǤ���С����
��� javadoc 1.2 �ޤ��� 1.3 ����Ѥ��Ƥ���������
.TP 3
\-source release
�����դ��륽���������ɤΥС���������ꤷ�ޤ���\f2release\fP �ˤϼ����ͤ����Ǥ��ޤ���
.LP
.TS
;
l l.
1.5 T{
Javadoc �ϡ�JDK 1.5 ��Ƴ����줿��ε�ǽ�����¾�θ��쵡ǽ��ޤ�����ɤ���դ��ޤ���-source �ե饰����ꤷ�ʤ��ȡ�����ѥ���ϥǥե���ȤȤ��� 1.5 ��ư��ޤ���
T}
1.4 T{
Javadoc �ϡ�JDK 1.4 ��Ƴ����줿��������������ޤॳ���ɤ���դ��ޤ���
T}
1.3 T{
Javadoc �ϡ�JDK 1.3 �ʹߤ�Ƴ����줿������������ε�ǽ���ޤ���¾�θ��쵡ǽ�ݡ��Ȥ��ޤ���
T}
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-14
.LP
javac �ǥ����ɤ�ѥ��뤹��Ȥ��˻��Ѥ����ͤ��б����� \f2release\fP ���ͤ���Ѥ��ޤ���
.LP
.TP
.BI \-sourcepath " sourcepathlist"
.B javadoc
���ޥ�ɤ˥ѥå�����̾�ޤ��� \-subpackages
���Ϥ��ݤˡ�
�������ե����� (.java) �����ѤΥѥ�����ꤷ�ޤ���
.BI sourcepathlist
�ˤϡ������ (\f3:\f1)
�Ƕ�ڤä�ʣ��Υѥ���ޤ�뤳�Ȥ��Ǥ��ޤ���
.B Javadoc
�ġ���ϡ����ꤵ�줿�ѥ��ʲ��Τ��٤Ƥ�
���֥ǥ��쥯�ȥ�����ޤ��� ���Υ��ץ�����Ȥäơ�
�ɥ�����Ȳ�����륽�����ե�����ΰ��֤����Ǥʤ���
���켫�Τϥɥ�����Ȳ�����Ƥ��ʤ������ɥ�����Ȳ�
����Ƥ��륽�����ե����뤫��Ѿ����줿�����Ȥ���
�������ե�����ΰ��֤��ǧ�Ǥ��ޤ���
.LP
.B \-sourcepath
���ץ����ϡ�
.B javadoc
���ޥ�ɤ�Ȥäƥѥå�����̾����ꤹ��Ȥ��ˤ������ѤǤ���
.B javadoc
���ޥ�ɤ��Ϥ����
.B .java
�ե�����ϸ����Ǥ��ʤ����Ȥ���դ��Ƥ���������
.B .java
�ե����������ˤϡ�
���Υǥ��쥯�ȥ�˰�ư���뤫��
�ƥե��������ˤ��Υѥ����դ��ޤ� (��1 �İʾ�
�Υѥå������Υɥ�����Ȳ��פ�)��
.B \-sourcepath
����ά���줿���ϡ�
.B javadoc
�ϥ��饹�ѥ���Ȥäƥ������ե���������ޤ� (
.B \-classpath
��)�� �������äơ�
.B \-sourcepath
�Υǥե���Ȥ�
.B \-classpath
���ͤǤ���
.B -classpath
���ά���ƥѥå�����̾��
.BR javadoc
���Ϥ�����硢
.BR javadoc
�ϡ��������ե�����θ��ߤΥǥ��쥯�ȥ� (����ӥ��֥ǥ��쥯�ȥ�) ��
�������ޤ���
.LP
.RS
.I sourcepathlist
�Ǥϡ��ɥ�����Ȳ�����ѥå�����̾��
�������ĥ�Υ롼�ȥǥ��쥯�ȥ��
���ꤷ�ޤ������Ȥ��С��������ե����뤬����
���ˤ���
.B com.mypackage
�Ȥ���̾���Υѥå�������ɥ�����Ȳ�����Ȥ��ޤ���
.LP
.RS
.ft 3
.nf
/home/user/src/com/mypackage/*.java
.fi
.ft 1
.RE
.LP
���ξ�硢���Τ褦�ˤ��ƥ������ѥ���
.BR /home/user/src
���Ĥޤ�
.BR com.mypackage
��ޤ�ǥ��쥯�ȥ�˻��ꤷ�����줫��ѥå�����̾
.BR com.mypackage
����ꤷ�ޤ���
.LP
.RS
.ft 3
.nf
% javadoc \-sourcepath /home/user/src/ com.mypackage
.fi
.ft 1
.RE
.LP
����ϡ��������ѥ����ͤȥѥå�����̾��Ĥʤ��ơ�
�ɥåȤ�å��� (/) ���Ѥ���ȡ��ʲ��Υѥå������Υե�ѥ�
�ˤʤ뤳�Ȥ����ܤ���ȳФ��䤹���Ǥ��礦��
.LP
.RS
.ft 3
.BR /home/user/src/com/mypackage
.RE
.LP
2 �ĤΥ������ѥ�����ꤹ��ˤϡ����Τ褦�ˤ��ޤ���
.LP
.RS
.ft 3
.nf
% javadoc \-sourcepath /home/user/src/:/home/user2/src com.mypackage
.fi
.ft 1
.RE
.LP
.RE
.TP
.BI \-classpath " classpathlist"
.B javadoc
�����Ȥ���륯�饹�θ�����Ԥ��ѥ�����ꤷ�ޤ���
���Ȥ���륯�饹 (\f3.class\f1) �Ȥϡ�
�ɥ�����Ȳ�����륯�饹�Ȥ����Υ��饹�ˤ�ä�
���Ȥ����Ǥ�դΥ��饹�Τ��ȤǤ���
.B javadoc
�ϡ����ꤵ�줿�ѥ��ʲ��Τ��٤ƤΥ��֥ǥ��쥯�ȥ��
������Ԥ��ޤ���
.I classpathlist
�ˤϡ��ѥ��֤�� (\f3:\f1) �Ƕ�ڤä�ʣ��Υѥ���
�ޤ�뤳�Ȥ��Ǥ��ޤ���
.B javadoc
�ġ���ϡ����ꤵ�줿�ѥ��ʲ���
���٤ƤΥ��֥ǥ��쥯�ȥ�����ޤ���
.IR classpathlist
���
�ˤĤ��Ƥϡ����饹�ѥ��Υɥ�����ȤȤ��Ƥ���������
.LP
.RS
.B \-sourcepath
���ά�������ϡ�
.B javadoc
�ġ���ϡ����饹�ե����� (���̸ߴ���) �ȤȤ�ˡ�
.B \-classpath
��Ȥäƥ������ե���������ޤ������Τ��ᡢ
�ۤʤ�ѥ���Υ������ե����뤪��ӥ��饹�ե������������ϡ�
.B \-sourcepath
��
.BR \-classpath
��ξ���Ȥ��ޤ���
.LP
���Ȥ��С�
.BR com.mypackage
��ɥ�����Ȳ����������ˡ��ѥå������Υ��饹���ǥ��쥯�ȥ�
.BR /home/user/src/com/mypackage
�ˤ��ꡢ���Υѥå�������
.BR /home/user/lib
��Υ饤�֥���Ȥ����ϡ����Τ褦�˻��ꤷ�ޤ���
.LP
.RS
.ft 3
.nf
% javadoc \-classpath /home/user/lib \-sourcepath /home/user/src com.mypackage
.fi
.ft 1
.RE
.LP
�ۤ��Υġ����Ʊ�ͤˡ�
.BR \-classpath
����ꤷ�ʤ����ϡ�CLASSPATH �Ķ��ѿ�
���ꤵ��Ƥ���С�
.B javadoc
�ġ���Ϥ��δĶ��ѿ��Ȥ��ޤ���
�ɤ������ꤵ��Ƥ��ʤ����
�ϡ�
.B javadoc
�ġ���ϸ��ߤΥǥ��쥯�ȥ�ǥ��饹�����ޤ���
.LP
.B javadoc
�ġ��뤬��ĥ��ǽ���饹����ӥ֡��ȥ��ȥ�åץ��饹���̿�����ݤˡ�
.B -classpath
��Ȥäƥ桼�����饹�������ˡ�ˤĤ��Ƥ�
�ܺ٤ϡ��֥��饹�θ����ˡ�פ�
���Ȥ��Ƥ���������
.LP
�ص��塢\f2*\fP �Υ١���̾��ޤ९�饹�ѥ���Ǥϡ��ǥ��쥯�ȥ���γ�ĥ�� \f2.jar\fP �ޤ��� \f2.JAR\fP ��Ĥ��٤ƤΥե�����Υꥹ�Ȥ���ꤹ��Τ�Ʊ���Ǥ���Ȥߤʤ���ޤ� (Java �ץ����Ϥ��� 2 �ĤθƤӽФ�����̤Ǥ��ʤ�)��
.br
.br
���Ȥ��С��ǥ��쥯�ȥ� \f2foo\fP �� \f2a.jar\fP �� \f2b.JAR\fP ���ޤޤ�Ƥ����硢���饹�ѥ���� \f2foo/*\fP �� \f2A.jar:b.JAR\fP ��Ÿ������ޤ�����������JAR �ե�����ν��֤�̤���Ȥʤ�ޤ������Υꥹ�Ȥˤϡ������ե������ޤᡢ���ꤵ�줿�ǥ��쥯�ȥ���Τ��٤Ƥ� JAR �ե����뤬�ޤޤ�ޤ���\f2*\fP ���������륯�饹�ѥ�����ȥ�ϡ������ȥǥ��쥯�ȥ���Τ��٤Ƥ� JAR �ե�����Υꥹ�Ȥ�Ÿ������ޤ���\f2CLASSPATH\fP �Ķ��ѿ�⡢�����ˤ�Ʊ�ͤ�Ÿ������ޤ������饹�ѥ��Υ磻��ɥ�����Ÿ����ɬ����Java ���ۥޥ���ε�ư���˼¹Ԥ���ޤ����������äơ�\f2System.getenv("CLASSPATH")\fP �ƤӽФ��ʤɤδĶ����Ф����䤤��碌��Ԥ�ʤ��¤ꡢŸ������Ƥ��ʤ��磻��ɥ����ɤ� Java �ץ���बǧ�����뤳�ȤϤ���ޤ���
.LP
.TP 3
\-subpackages\ \ package1:package2:...
�������ե����뤫����ꤵ�줿�ѥå���������Ӥ��Υ��֥ѥå�������˺Ƶ�Ū�˥ɥ�����Ȥ�����ޤ������Υ��ץ����ϡ������������ɤ˿��������֥ѥå��������ɲä���ݤ�����Ǥ������������֥ѥå������ϼ�ưŪ��Ȥ߹��ޤ�ޤ����� package ����ϡ�Ǥ�դκǾ�̥��֥ѥå����� (java �ʤ�) �ޤ��ϴ�������Υѥå����� (javax.swing �ʤ�) �ˤʤ�ޤ����������ե������ޤ��ɬ�פϤ���ޤ�����ϡ������Ƕ�ڤ��ޤ� (���٤ƤΥ��ڥ졼�ƥ������ƥ�)���磻��ɥ����ɤ����פǤ� (�����Բ�)���ѥå������θ���������ꤹ��ˤϡ�\-sourcepath ����Ѥ��ޤ������Υ��ץ����ϡ��֥������ե�����ν���פ��������Ȥ��ꡢ�������ĥ�ˤ��뤬�ѥå������ˤ�°���Ƥ��ʤ��������ե�����������ʤ��Τ���Ω���ޤ���
.LP
��������ޤ���
.nf
\f3
.fl
% \fP\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax.swing\fP
.fl
.fi
���Υ��ޥ�ɤϡ���java�פ���ӡ�javax.swing�פȤ���̾���Υѥå������Ȥ����Υ��֥ѥå���������Υɥ�����Ȥ�����ޤ���
.LP
\f2\-exclude\fP �ȤȤ�� \f2\-subpackages\fP ����Ѥ���ȡ�����Υѥå���������Ǥ��ޤ���
.LP
.TP 3
\-exclude\ \ packagename1:packagename2:...
���ꤵ�줿�ѥå������Ȥ��Υ��֥ѥå������� \f2\-subpackages\fP �ˤ�äƺ����줿�ꥹ�Ȥ���̵���˽������ޤ������� \f2\-subpackages\fP ���ץ����λ���ˤ�ä�Ȥ߹��ޤ줿�ѥå��������ޤ��Ͼ���Ȥ߹��ޤ��ѥå������������оݤȤʤ�ޤ�����������ޤ���
.nf
\f3
.fl
% \fP\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude java.net:java.lang\fP
.fl
.fi
���Τ�����\f2java.io\fP��\f2java.util\fP��\f2java.math\fP ��Ȥ߹��ޤ�ޤ�����\f2java.net\fP �� \f2java.lang\fP �ʲ��Υѥå������Ͻ�������ޤ�����������\f2java.lang\fP �Υ��֥ѥå������Ǥ��� \f2java.lang.ref\fP �Ͻ�������ޤ���
.RE
.TP
.BI \-bootclasspath " classpathlist"
�֡��ȥ��饹��¸�ߤ���ѥ�����ꤷ�ޤ���
�֡��ȥ��饹�Ȥϡ�Java �ץ�åȥե����९�饹�Τ��ȤǤ���
.B bootclasspath
�ϡ�
.B javadoc
�ġ��뤬�������ե�����ȥ��饹�ե������õ���Ȥ���
�Ȥ������ѥ��ΰ���Ǥ����ܺ٤ϡ�
��Javac �� Javadoc �����饹�������ˡ�� ��
���Ȥ��Ƥ���������
.I classpathlist
���ʣ���
���饹�ѥ��ꥹ�Ȥϡ������ (:) �Ƕ�ڤ�ޤ���
.TP
.BI \-extdirs " dirlist"
��ĥ��ǽ���饹��¸�ߤ���ǥ��쥯�ȥ����ꤷ�ޤ���
��ĥ��ǽ���饹�ϡ�Java ��ĥ��ǽ
������Ȥ����٤ƤΥ��饹�Ǥ�����ĥ��ǽ�ǥ��쥯�ȥ� (
.B extdirs
) �ϡ�
.B javadoc
�ġ��뤬�������ե�����ȥ��饹�ե������õ���Ȥ��˻Ȥ������ѥ��ΰ���Ǥ���
�ܺ٤ϡ����
.B \-classpath
�Ȥ��Ƥ���������
.I dirlist
���ʣ��Υǥ��쥯�ȥ�ϡ�
����� (:) �Ƕ�ڤ�ޤ���
.TP
.B \-verbose
.B javadoc
�μ¹���˾ܺ٤ʥ�å�������ɽ�����ޤ�����Ĺ���ץ�����
���ꤷ�ʤ����ϡ��������ե�����Υ��ɻ����ɥ�����Ȥ�
������ (�������ե����뤴�Ȥ� 1 �ĤΥ�å�����)������ӥ����Ȼ���
��å�������ɽ������ޤ�����Ĺ���ץ�������ꤷ�����ϡ�
�� java �������ե�����β�Ϥ��פ����ߥ��ÿ�ʤɤ�
�ɲå�å�������ɽ�����ޤ���
.TP
.BI \-quiet
���顼��å������ʳ�������ӷٹ��å������ʳ���
�������������
���顼��å���������ӷٹ��å�����������
ɽ�����Ƹ��Ĥ��䤹�����ޤ���
�ޤ����С������ʸ�����ɽ����������ޤ���
.LP
.TP 3
\-breakiterator\
�Ѹ���Ȥ����������ͭ�Υ��르�ꥺ��ǤϤʤ���\f2java.text.BreakIterator\fP �ι�ݲ����줿ʸ��������Ѥ��ơ���ʸ�κǽ��ʸ�ν�����Ƚ�Ǥ��ޤ� (¾�Τ��٤ƤΥ�����Ϥ��Ǥ� \f2BreakIterator\fP �����)����\f2�ǽ��ʸ\fP�פȤϡ��ѥå����������饹���ޤ��ϥ��Фμ����Ǥκǽ��ʸ�Τ��ȤǤ�������ʸ�ϡ��ѥå����������饹���ޤ��ϥ��Ф�����˥��ԡ����졢����ե��٥åȽ�Υ���ǥå����˥��ԡ�����ޤ���
.LP
JDK 1.2 �ʹߡ�BreakIterator ���饹�ϡ��Ѹ������٤Ƥθ����ʸ�ν�����Ƚ�Ǥ��뤿��ˡ����Ǥ˻��Ѥ���Ƥ��ޤ����������äơ�1.2 �ʹߤǤϡ�\f2\-breakiterator\fP ���ץ����ϱ�ʸ�ʳ��ˤϸ��̤�����ޤ���ʸ�ˤϡ����Τ褦���ȼ��Υǥե���ȤΥ��르�ꥺ�ब����ޤ���
.RS 3
.TP 2
o
��ʸ�Υǥե���Ȥ�ʸ��ڤꥢ�르�ꥺ�� \- ����ޤ��� HTML �֥�å����� (\f2<P>\fP �ʤ�) ��³���ԥꥪ�ɤ���ߤ���
.TP 2
o
breakiterator ʸ��ڤꥢ�르�ꥺ�� \- ���̤ˡ����θ줬��ʸ���ǻϤޤ��硢����ʸ����³���ԥꥪ�ɡ������䡢�ޤ��ϴ�ò�����ߤ��롣���Υ��르�ꥺ��Ǥϡ��ۤȤ�ɤξ�άɽ������������ (��The serial no. is valid�פϽ������뤬��Mr. Smith�פϽ������ʤ�)��HTML �����䡢��ޤ��ϵ���ǻϤޤ�ʸ�Ǥ���ߤ��ʤ���HTML ����������ޤ�Ƥ�����Ǥ⡢��../filename�פκǸ�Υԥꥪ�ɤ���ߤ���
.RE
.RS 3
.LP
.LP
��: 1.5.0 ����ϡ�1.4.x ��ߤ����Ƥ��� breakiterator �ٹ��å�������������ǥե���Ȥ�ʸ��ڤꥢ�르�ꥺ����ѹ����Ƥ��ޤ��Ĥޤꡢ\-breakiterator ���ץ����ϡ�1.5.0 �Ǥϥǥե���ȤǤϤʤ��ʤꡢ�ޤ��ǥե���Ȥˤ���Ĥ��⤢��ޤ�����ϡ��ּ��Υ�㡼������(1.5.0) �ǥǥե���Ȥ��ѹ�����Ȥ������������Ū�ȤϵդˤʤäƤ��ޤ����Ĥޤꡢ�����������ɤ��ѹ�������1.4.x �Ǥ� breakiterator �ٹ���Ƥ��ʤ����Ǥ⡢1.5.0 ����ϲ��⤹��ɬ�פ��ʤ����ٹ�Ͼ��Ǥ��Ƥ��ޤ������ε������ͳ�ϡ�breakiterator ��ǥե���Ȥˤ�����åȤ��⡢�ǥե���Ȥˤ��뤿���ɬ�פȤʤ롢�ߴ����Τʤ����������ѹ��������ô���礭���ä�����Ǥ����������䤷����Ȥ亮��̵�̤ˤʤ��ǰ�Ǥ���
.LP
.TP
.BI \-locale " language_country_variant"
.B ����:
\-locale ���ץ����ϡ�ɸ��ɥå���åȤ䤽��¾�Υɥå���å�
�ˤ�ä�����륪�ץ��������� (��¦��)
���ꤹ��ɬ�פ�����ޤ��������Ǥʤ���С��ʥӥ��������С���
�Ѹ��ɽ������ޤ������˰�¸���륳�ޥ�ɹԥ��ץ����ϡ�
���Υ��ץ����ΤߤǤ���
.LP
.RS
.B javadoc
���ɥ�����Ȥ������Ȥ��˻Ȥ����������ꤷ�ޤ���
����ˤϡ�java.util.Locale �Υɥ�����Ȥ�������Ƥ���
���������ꤷ�ޤ���
���Ȥ��С�en_US (�Ѹ졢�ƹ�)��en_US_WIN (Windows �ǻȤ���Ѹ�) �ʤɤ�
���ꤷ�ޤ���
.LP
���������ꤹ��ȡ�
.B javadoc
�ϻ��ꤵ�줿������Υ�����ե��������
��å����� (�ʥӥ��������С����ꥹ�Ȥ�ɽ�θ��Ф���
�إ�ץե�������ܼ���
.BR stylesheet.css
�Υ����Ȥʤɤ�ʸ����) ��
�Ȥ��ޤ����ޤ�������ե��٥åȽ�˥����Ȥ����ꥹ�ȤΥ����Ƚ硢
����Ӻǽ��ʸ��������ꤹ��ʸ�ζ�ڤ�ʸ���⡢
���ꤷ��������ˤ�äƷ�ޤ�ޤ������Υ��ץ����ϡ�
�ɥ�����Ȳ�����륯�饹�Υ������ե��������
���ꤵ��Ƥ��� doc �����ȥƥ����Ȥ�
���������ꤹ���ΤǤϤ���ޤ���
.RE
.TP
.BI \-encoding " name"
�������ե�����Υ����ǥ���̾ (EUCJIS/SJIS �ʤ�) ����ꤷ�ޤ���
���Υ��ץ�����ꤵ��Ƥ��ʤ����ϡ��ץ�åȥե������
�ǥե���ȥ���С������Ȥ��ޤ���
.LP
\-docencoding ����� \-charset �⻲�Ȥ��Ƥ���������
.TP
.BI \-J flag
.BR javadoc
��¹Ԥ���¹ԥ����ƥ� java �� flag ��ľ���Ϥ��ޤ���J �� flag �δ֤�
��������ƤϤʤ�ޤ����Ȥ��С����������
�ɥ�����Ȥ������뤿��ˡ������ƥ�� 32M �Х��Ȥ�
���ݤ���ɬ�פ�������ϡ�Java ��
.B \-Xmx
���ץ����Τ褦�˸ƤӽФ��ޤ���\-Xms �ϥ��ץ����Ǥ���������Υ������Τߤ���ꤹ�뤿�ᡢɬ�פʺǾ�������ΤäƤ����������Ǥ���
.LP
.RS
.ft 3
.nf
% javadoc \-J\-Xmx32m \-J\-Xms32m com.mypackage
.fi
.ft 1
.RE
.LP
���Ѥ��Ƥ��� javadoc �ΥС��������ǧ����ˤϡ�
���Τ褦�� java �Ρ�-version�ץ��ץ�����ƤӽФ��ޤ���
.LP
.RS
.ft 3
.nf
% javadoc -J-version
java version "1.2"
Classic VM (build JDK-1.2-V, green threads, sunwjit)
.fi
.ft 1
.RE
.LP
(ɸ��ɥå���åȤΥС�������ֹ�Ͻ��ϥ��ȥ���ɽ������ޤ���)
.SS "ɸ��ɥå���åȤ����륪�ץ����"
.TP
.BI \-d " directory"
�������줿 HTML �ե��������¸����ǥ��쥯�ȥ��
���ꤷ�ޤ� (d �ϡ������ (destination)�פΰ�̣)�����Υ��ץ�����
��ά����ȡ��������줿�ե�����ϸ��ߤΥǥ��쥯�ȥ����¸����ޤ���
��
.I directory
�ˤϡ����Хǥ��쥯�ȥ�ޤ��ϸ��ߤκ��
�ǥ��쥯�ȥ꤫�����Хǥ��쥯�ȥ�����Ǥ��ޤ���
1.4 �Ǥϡ�javadoc �μ¹Ի���
��ưŪ�������ǥ��쥯�ȥ꤬������ޤ���
.LP
���Ȥ��С�
������ϡ�com.mypackage �ѥå������Υɥ�����Ȥ������
��̤�
.B /home/user/doc/
�ǥ��쥯�ȥ����¸���ޤ���
.LP
.RS
.ft 3
.nf
% javadoc \-d /home/user/doc com.mypackage
.fi
.ft 1
.RE
.TP
.B \-use
�ɥ�����Ȳ�����륯�饹�ȥѥå��������Ȥ� 1 �Ĥ� [����] �ڡ�����
�ޤ�ޤ������Υڡ����ˤϡ��ɥ�����Ȳ�����륯�饹�ޤ���
�ѥå������� API ��ȤäƤ���ѥå����������饹����åɡ�
���ȥ饯��������ӥե�����ɤ����Ҥ���ޤ������Ȥ��С����饹
C ����ӥ��饹 C ��Ȥ���Τϡ�C �Υ��֥��饹��C �Ȥ���
������Ƥ���ե�����ɡ�C ���֤���åɡ�����ӡ��� C ��
�ѥ�����ĥ�åɤȥ��ȥ饯�����ڡ����˴ޤ�
��ޤ���
.LP
.RS
���Ȥ��С�String �ˤĤ��ơ�[����] �ڡ����˲���ɽ������뤫��
���Ƥߤޤ��礦��
.B java.awt.Font
���饹��
.B getName()
��åɤϡ�String �����֤��ޤ���
���Τ��ᡢ
.B getName()
�� String ��Ȥ��Τǡ�[����] �ڡ����� String ��
���Υ�åɤĤ��뤳�Ȥ��Ǥ��ޤ���
.LP
���Υڡ����Ǥ� API �λ��Ѥ������ɥ�����Ȳ����졢����ϥɥ�����Ȳ�����ޤ���
�����åɤ������� String ��ȤäƤ��뤬������Ȥ���
ʸ�����Ȥä��ꡢʸ������֤����ꤷ�ʤ�
���ϡ�String �Ρֻ��ѡפȤϤߤʤ���ޤ���
.LP
�������줿 [����] �ڡ����˥�����������ˤϡ���Ū�Υ��饹�ޤ���
�ѥå�������ɽ�����ơ��ʥӥ��������С��� [����] ���
����å����ޤ���
.RE
.TP
.B \-version
���������ɥ�����Ȥ�
.B @version
�ƥ����Ȥ�ޤ�ޤ������Υƥ����Ȥϡ��ǥե���ȤǤϾ�ά����ޤ���
���Ѥ��Ƥ��� javadoc �ġ���ΥС��������ǧ����ˤϡ�
.B \-J\-version
���ץ�������Ѥ��ޤ���
.TP
.B \-author
���������ɥ�����Ȥ�
.B @author
�ƥ����Ȥ�ޤ�ޤ���
.TP
.B \-splitindex
�����ե������ե��٥åȤ��Ȥ�ʣ��Υե������ʬ�䤷��
ʸ�����Ȥ� 1 �ĤΥե�����ȡ�����ե��٥åȰʳ���ʸ���ǻϤޤ�
��������ȥ��ѤΥե������ 1 �ĺ����ޤ���
.TP
.BI \-windowtitle " title"
HTML ��
.B <title>
�����ǻȤ������ȥ����ꤷ�ޤ������ꤷ�������ȥ�ϡ�
������ɥ������ȥ�ȡ��������ڡ������Ф��ƺ����줿�֥饦����
�֥å��ޡ��� (�褯��������������) ��ɽ������ޤ���
�����ȥ�ˤ� HTML ������ޤ�ʤ��Ǥ��������������ȥ�� HTML ������
�ޤޤ�Ƥ���ȡ��֥饦���ˤ�륿���β���Ŭ�ڤˤʤ�
��ǽ��������ޤ���
.I title
����ǰ������Ȥ����ϡ��������
���������פ���ɬ�פ�����ޤ���
.B -windowtitle
����ά����Ƥ����硢
.B javadoc
�ġ���Ϥ��Υ��ץ���������� -doctitle ���ͤ�Ȥ��ޤ���
.LP
.RS
.ft 3
.nf
% javadoc -windowtitle "Java 2 Platform" com.mypackage
.fi
.ft 1
.RE
.TP
.BI \-doctitle " title"
���ץե�����κǾ��������֤��륿���ȥ����ꤷ�ޤ���
�����ȥ����·�����졢��٥� 1 �θ��Ф��Ȥ��ƾ���
�ʥӥ��������С��Τ��������֤���ޤ���
.I title
�ˤϡ�HTML ������
�����ޤ�뤳�Ȥ��Ǥ��ޤ�����������ޤ�������Τ�����ǰ�
�ޤʤ���Фʤ�ޤ���
.I title
����ǰ������Ȥ����ϡ�������������פ���ɬ�פ�����ޤ���
.LP
.RS
.ft 3
.nf
% javadoc -doctitle "Java<sup><font size=\"-2\">TM</font></sup>" com.mypackage
.fi
.ft 1
.RE
.TP
.BI \-title " title"
���Υ��ץ����ϡ����ߤ�¸�ߤ��ޤ���
.B javadoc
1.2 �Υ١����Ǥˤ���¸�ߤ��ޤ��������Υ��ץ����ϡ�
������ɥ������ȥ�ǤϤʤ��ɥ�����ȥ����ȥ�������뤳�Ȥ�
��Τˤ��뤿�ᡢ
.BR \-doctitle
��̾�����ѹ�����ޤ�����
.TP
.BI \-header " header"
�ƽ��ϥե�����ξ�������֤���إå��ƥ����Ȥ���ꤷ�ޤ����إå��ϡ�
����ʥӥ��������С��α�¦�����֤���ޤ���
.I header
�ˤϡ�HTML ������
�����ޤ�뤳�Ȥ��Ǥ��ޤ�����������ޤ�������Τ������
�Ϥޤʤ���Фʤ�ޤ���header ����ǰ������Ȥ����ϡ��������
���������פ���ɬ�פ�����ޤ���
.nf
\f3
.fl
% \fP\f3javadoc \-header "<b>Java 2 Platform </b><br>v1.4" com.mypackage\fP
.fl
.fi
.LP
.TP
.BI \-footer " footer"
�ƽ��ϥե�����β�������֤���եå��ƥ����Ȥ���ꤷ�ޤ����եå��ϡ�
����ʥӥ��������С��α�¦�����֤���ޤ���
.I footer
�ˤϡ�HTML ������
�����ޤ�뤳�Ȥ��Ǥ��ޤ�����������ޤ�������Τ������
�Ϥޤʤ���Фʤ�ޤ���
.I footer
����ǰ������Ȥ����ϡ�������������פ���ɬ�פ�����ޤ���
.TP
.BI \-bottom " text"
�ƽ��ϥե�����κDz�������֤���ƥ����Ȥ���ꤷ�ޤ���
���Υƥ����Ȥϡ�����ʥӥ��������С��β��Υڡ����κDz����
���֤���ޤ���
.I text
�ˤϡ�HTML �����ȶ����ޤ�뤳�Ȥ��Ǥ��ޤ�����
������ޤ�������Τ�����ǰϤޤʤ���Фʤ�ޤ���
.I text
����ǰ������Ȥ����ϡ�������������פ���ɬ�פ�����ޤ���
.TP
.BI \-link " extdocURL"
.B javadoc
�ġ���ˤ�������줿��¸��
����ȥ��饹�Υɥ�����ơ������ؤΥ������ޤ���
����� 1 �ĤǤ���
.TP
\(bu
.I extdocURL
�ϡ�javadoc �ˤ�ä�������졢����Ȥ��ƻ��ꤹ��
����ɥ�����Ȥ�����ǥ��쥯�ȥ����� URL �ޤ������ URL �Ǥ��� ���Ȥ�����ޤ��� ���Υǥ��쥯�ȥ���� package-list �ե����뤬¸�ߤ���
���ʤ���Фʤ�ޤ���¸�ߤ��ʤ����ϡ�\-linkoffline ����Ѥ��ޤ���
.B javadoc
�ġ���� package-list �ե����뤫��ѥå�����̾���ɤ�ꡢ�����
.I extdocURL
�Υѥå������˥���ޤ��� javadoc �ġ����¹Ԥ���ȡ�
.I extdocURL
�ͤϺ����줿 <A HREF> ��ˤ��Τޤޥ��ԡ�����ޤ��� �������äơ�
.I extdocURL
�ϥե�����ǤϤʤ���
.I extdocURL
�� URL �Ǥ���ɬ�פ�����ޤ���
.LP
�ɥ�����Ȥ�Ǥ�դ� Web �����Ⱦ�Υɥ�����Ȥ˥����ˤ�
.I extdocURL
����Х����Х�������������ꤹ��ˤ�
���Х����ѤǤ��ޤ������Х����Ѥ����硢������ǥ��쥯�ȥ� (\-d �ǻ���) �������Хѥ���
����ѥå�����������ǥ��쥯�ȥ���Ϥ�ɬ�פ�����ޤ���
.LP
�̾���Х����ꤹ����ϡ�http: �����Ѥ��ޤ���
��������Web �����Ф�⤿�ʤ��ե����륷���ƥ��
�������ϡ�file: �����ѤǤ��ޤ���
�������������ˡ�ϡ��������줿�ɥ�����Ȥ�
�����������褦�Ȥ���
���٤ƤΥ桼����Ʊ���ե����륷���ƥ��ͭ���Ƥ���
���ʳ��ϻ��Ѥ��ʤ��Ǥ���������
.LP
���٤Ƥξ�硢���٤ƤΥ��ڥ졼�ƥ������ƥ�ǡ����� URL ����� URL����http:�ץ١����ȡ�file:�ץ١����ˤ�����餺������å�����ڤ�ʸ���Ȥ��ƻ��Ѥ��ޤ�
.fi
(http://www.ietf.org/rfc/rfc1738.txt
��
.na
\f2URL Memo\fP �ǻ���)��
.RS 3
.TP 3
http: �١�������Х��:
\f2\-link http://<host>/<directory>/<directory>/.../<name>\fP
.TP 3
file: �١�������Х��:
\f2\-link file://<host>/<directory>/<directory>/.../<name>\fP
.TP 3
�����:
\f2\-link <directory>/<directory>/.../<name>\fP
.RE
.RE
.LP
javadoc �¹Ի���ʣ��� \-link ���ץ�������ꤷ�ơ�
ʣ��Υɥ�����ȤؤΥ������뤳�Ȥ�Ǥ��ޤ���
.LP
\-linkoffline �ޤ��� \-link �����
.LP
\-link ����Ѥ�����:
.TP 3
\(bu
���� API �ɥ�����Ȥؤ���Хѥ�����Ѥ��Ƥ���
.TP 3
\(bu
���� API �ɥ�����Ȥؤ���� URL ����Ѥ��Ƥ��� (�ץ���ब���� URL ���³�����ɤ���Ԥ����Ȥ�
������ˤ�äƵ��Ĥ���Ƥ�����)
.LP
\-linkoffline ����Ѥ�����:
.TP 3
\(bu
���� API �ɥ�����Ȥؤ���� URL ����Ѥ��Ƥ���
(�ץ���ब���� URL ���³�����ɤ���Ԥ����Ȥ�
������ˤ�äƵ��Ĥ���Ƥ��ʤ����)�����Τ褦�ʾ����ϡ�
����Υɥ�����Ȥ��ե��������������
������¦�ˤ������ȯ�����ޤ���
.LP
����ɥ�����Ȥؤ���Х�λ����� -
java.lang��java.io�������¾�� Java 2 �ץ�åȥե�����ѥå�����
(\f2http://java.sun.com/j2se/1.5.0/docs/api\fP) ��
���������礬����ޤ���
���Υ��ޥ�ɤϡ�
Java 2 �ץ�åȥե�����ѥå������ؤΥ���
com.mypackage �ѥå������Υɥ�����Ȥ�����ޤ���
�������줿�ɥ�����Ȥˤϡ����Ȥ��Х��饹�ĥ���
Object ���饹�ؤΥ���ޤޤ�Ƥ��ޤ�
(\-sourcepath �� \-d �ʤɤ�¾�Υ��ץ�����ɽ������ޤ���)��
.LP
.RS
.ft 3
.nf
% \fP\f3javadoc \-link http://java.sun.com/j2se/1.5.0/docs/api com.mypackage\fP
.fi
.ft 1
.RE
.LP
���� �ɥ�����Ȥؤ���Х�λ����� -
.B javadoc
�ġ���ΰۤʤ�¹Ԥ�������줿�ɥ�����Ȥ��
2 �ĤΥѥå����������ꡢ����餬�̡���
���Хѥ����äƤ���Ȥ��ޤ���
������Ǥϡ�2 �ĤΥѥå�������
com.apipackage (API)��com.spipackage
(SPI - Service Provide Interface) �Ȥ��ޤ��� �ɥ�����Ȥ��֤����� docs/api/com/apipackage �����
docs/spi/com/spipackage �Ǥ���
API �ѥå������ɥ�����ȤϤ��Ǥ�������졢�ɥ�����Ȥ����ߤ�
�ǥ��쥯�ȥ���ˤ����硢���Τ褦�˼¹Ԥ��뤳�Ȥǡ�
API �ɥ�����Ȥ˥���� SPI �ѥå�������ɥ�����Ȳ��Ǥ��ޤ���
.LP
.RS
.ft 3
.nf
% javadoc \-d ./spi \-link ../api com.spipackage
.fi
.ft 1
.RE
.LP
\-link ���������ǥ��쥯�ȥ����Хѥ� (docs/spi) ��
���뤳�Ȥ���դ��Ƥ���������
.LP
�ܺ� -
\-link ���ץ�����Ȥ��ȡ������ɤ���ϻ��Ȥ���Ƥ��Ƥ⡢
Javadoc �θ��ߤμ¹ԤǤϥɥ�����Ȳ�����ʤ����饹�˥��
�Ǥ���褦�ˤʤ�ޤ��� �����ͭ���ʥڡ�����
��ư�Ǥ���褦�ˤ���ˤϡ������� HTML �ڡ�����
�������Ĵ�١����ξ���
.I extdocURL
�˻��ꤹ��ɬ�פ�����ޤ���
���Υ��ץ�����Ȥ��ȡ����Ȥ��С������ɥѡ��ƥ��Υɥ�����Ȥ��顢
http://java.sun.com �ˤ��� java.* �Υɥ�����Ȥ˥���뤳�Ȥ��Ǥ��ޤ���
.LP
����μ¹Ԥ�
.B javadoc
�ˤ�ä���������ɥ���������
API �������оݤ˥���������ϡ�
\-link ���ץ������ά���ޤ��� \-link ���ץ����
���ꤵ��Ƥ��ʤ���硢
.B javadoc
�ġ���ϡ�����Ȥ��줿�ɥ�����ȤؤΥ��
�����ޤ�����ϡ����Υɥ�����Ȥ�
¸�ߤ��뤫�ɤ��������뤤��¸�ߤ��Ƥ��Ƥ�ɤ���
¸�ߤ��Ƥ���Τ���Ƚ�̤Ǥ��ʤ�����Ǥ���
.LP
���Υ��ץ����ϡ������ɥ���������ʣ��ξ���
�����Ǥ��ޤ���
.LP
�ޤ������Υ��ץ�����Ȥ��ȡ�ʣ��Υѥå��������δ֤˥����������뤳�Ȥ�Ǥ��ޤ����Ĥޤꡢ����켰�Υѥå��������Ф��� javadoc ��¹Ԥ������ȡ��̤ΰ켰�Υѥå��������Ф��� javadoc ��¹Ԥ�������� 2 �ĤΥѥå��������δ֤˥��������Ǥ��ޤ���
.LP
\f3���饹�λ����ˡ\fP - ����ȥ��饹�ؤΥ�ƥ����ȥ�٥����ǤϤʤ��ºݤ�ɽ������ˤϡ������ˡ�ǥ��饹�Ȥ���ɬ�פ�����ޤ�����åɤ����Τǥ��饹�Ȥ������ǤϽ�ʬ�ǤϤ���ޤ���\f2import\fP ʸ�ޤ�����ǻ��Ȥ���ɬ�פ�����ޤ������ˡ����饹 \f2java.io.File\fP �Ȥ����ˡ������ޤ���
.RS 3
.TP 2
o
���٤Ƥμ���� \f2import\fP ʸ�ξ��: �磻��ɥ����ɤˤ�륤��ݡ��ȡ�̾���ˤ�����Ū�ʥ���ݡ��ȡ��ޤ��� \f2java.lang.*\fP ���Ф��뼫ưŪ�ʥ���ݡ��ȡ����Ȥ��С����Τ褦�ˤ���н�ʬ�Ǥ���
.br
\f2import java.io.*;\fP
.br
1.3.x ����� 1.2.x �Ǥϡ�̾���ˤ�����Ū�ʥ���ݡ��Ȥ����Ǥ����磻��ɥ����ɤˤ�륤��ݡ���ʸ�⡢��ư����ݡ��� \f2java.lang.*\fP ����ѤǤ��ޤ���
.TP 2
o
����:
.br
\f2void foo(File f) {}\fP
.br
���λ��Ȥ���Ѥ�����åɡ����ȥ饯�����ե�����ɡ����饹���ޤ��ϥ��ե������Υ�����פޤ��ϥѥ��������פ��֤�����\f2implements\fP��\f2extends\fP���ޤ��� \f2throws\fP ʸ���֤��ޤ���
.RE
.LP
���η�̡�\f2\-link\fP ���ץ�������Ѥ��Ƥ⡢������¤Τ���˸�ä�ɽ������ʤ�¿���Υ��¿��ȯ�������ǽ��������ޤ����ƥ����Ȥϥϥ��ѡ��ƥ����ȥ���դ���줺��ɽ������ޤ��������Υ��ɽ������ٹ𤫤顢���Υ��ǧ���Ǥ��ޤ������饹��������Ȥ�������ˤ�äƥ���ɲä��뤿��Τ�äȤ������ˡ�Ͼ���������Ȥ��ꡢ����Υ��饹��ݡ��Ȥ��뤳�ȤǤ���
.LP
.B �ѥå������ꥹ��:
.B \-link
���ץ����Ǥϡ�javadoc �ġ���ˤ�ä�������줿
.BR package-list
�Ȥ���̾���Υե����뤬�����Υ��ץ����ǻ��ꤹ�� URL ��¸�ߤ��Ƥ���
ɬ�פ�����ޤ���
.BR package-list
�ե�����ϡ����ξ��ǥɥ�����Ȳ�����Ƥ���ѥå�������
̾���Υꥹ�Ȥ�ޤ�ñ��ʥƥ����ȥե�����Ǥ���
������Ǥϡ�
.B javadoc
�ġ���ϡ����ꤵ�줿 URL �ˤ���
.BR package-list
�Ȥ���̾���Υե������õ�����ѥå�����̾���ɤ߹���ǡ�
���� URL �ˤ��뤽���Υѥå������ؤΥ������ޤ�����
.LP
���Ȥ��С�Java �ץ�åȥե����� v5.0 API �Υѥå������ꥹ�Ȥϰʲ��ˤ��ꡢ
.na
\f2http://java.sun.com/j2se/1.5.0/docs/api/package\-list\fP
.RE
.LP
���Τ褦�����ƤǻϤޤäƤ��ޤ���
.LP
.RS
.ft 3
.nf
java.applet
java.awt
java.awt.color
java.awt.datatransfer
java.awt.dnd
java.awt.event
java.awt.font
����¾ ...
.fi
.ft 1
.RE
.LP
.B \-link
���ץ�������ꤻ����
.B javadoc
�ġ����¹Ԥ�����硢�ɥ�����Ȥ�������˳����
���饹��°����̾����
���Ĥ���ȡ�
.B javadoc
�Ϥ���̾��������ʤ����ǽ��Ϥ��ޤ��������
.B \-link
���ץ�����ꤵ��Ƥ����硢
.B javadoc
�ġ���ϡ����ꤵ�줿
.IR extdocURL
�ξ��ˤ���
.B package-list
�ե����뤫�顢�������̾���Υѥå�������õ���ޤ����ѥå�����̾��
���Ĥ��ä����ϡ�����
.IR extdocURL
��̾��������դ��ޤ���
.LP
���٤ƤΥ����������ǽ���뤿��ˤϡ�����Ȥ�
�ɥ�����ȤΤ��٤Ƥ������ꤵ�줿 URL ��
¸�ߤ��Ƥ��ʤ���Фʤ�ޤ���
.B javadoc
�ġ���ϡ�
.B package-list
��¸�ߤ��뤫�ɤ�����Ĵ�٤����ǡ����ꤵ�줿 URL ��
��Ū�Υڡ�����¸�ߤ��뤫�ɤ����ϥ����å����ޤ���
.LP
.B ʣ��Υ��:
ʣ���
.B \-link
���ץ��������ơ������������줿�ɥ�����Ȥ�Ǥ�տ�Υ�����Ǥ��ޤ���Javadoc 1.2 �ˤϡ�ʣ���
.B -link
���ޥ�ɤ��Ǥ��ʤ��Ȥ����Х�������ޤ������ΥХ��ϡ�
1.2.2 �ǽ�������ޤ�����
.LP
����볰��ɥ�����Ȥ��Ȥ��̤Υ���ץ�������ꤷ�ޤ���
.LP
.RS
.ft 3
.nf
% javadoc \-link extdocURL1 \-link extdocURL2 ... \-link extdocURLn com.mypackage
.fi
.ft 1
.RE
.LP
.BR extdocURL1��
.BR extdocURL2��...
.BR extdocURLn
�ϡ����줾�쳰��ɥ�����Ȥ�
�롼�Ȥ�ؤ����ƥ롼�Ȥˤϡ�
.BR package-list
�Ȥ���̾���Υե����뤬�ޤޤ�Ƥ��ޤ���
.LP
������� - �ޤ���������Ƥ��ʤ� 2 �İʾ�Υɥ�����Ȥ�
�����������ϡ��֥֡��ȥ��ȥ�åԥפ�ɬ�פˤʤ뤳�Ȥ�
��դ��Ƥ�������������������ȡ��ɤΥɥ�����Ȥ�
.B package-list
��¸�ߤ��Ƥ��ʤ���硢�ǽ�Υɥ�����Ȥ��Ф���
.B javadoc
�ġ����¹Ԥ�������Ǥϡ�2 ���ܤΥɥ�����Ȥ�
.B package-list
�Ϥޤ�¸�ߤ��Ƥ��ޤ��������äơ������������ˤϡ�
2 ���ܤΥɥ�����Ȥ�
�����������ȡ��ǽ�Υɥ�����Ȥ����ľ��ɬ�פ�����ޤ���
.LP
���ξ�硢�ǽ�˹Ԥ��ɥ�������������Ū�ϡ�
.B package-list
������뤳�ȤǤ����ѥå�����̾�٤��İ����Ƥ�����ϡ�
.B package-list
���ư�Ǻ����뤳�Ȥ�Ǥ��ޤ������ˡ�2 ���ܤΥɥ�����Ȥ�
���γ���������ޤ���
.B javadoc
�ġ���ϡ�ɬ�פʳ����
.B package-list
�ե����뤬¸�ߤ��ʤ����ϡ��ٹ��ɽ�����ޤ���
.TP
.BI \-linkoffline " extdocURL packagelistLoc"
���Υ��ץ����ϡ�
.BR \-link
���ץ������Ѥ�����ΤǤ����ɤ���⡢javadoc ��
�������줿����ȥ��饹�Υɥ�����ȤؤΥ������ޤ���
.B Javadoc
�ġ��뤬�֥��ե饤��פǡ�Web ��Υɥ�����Ȥ�
�������ϡ�Web ��³��ͳ�Ǥϥɥ�����Ȥ�
���������Ǥ��ʤ����ᡢ
.B \-linkoffline
���ץ�������Ѥ��ޤ���
.LP
��̩�ˤϡ�����ɥ�����Ȥ� \f2package\-list\fP �ե�����˥��������Ǥ��ʤ��Ȥ����ޤ��Ϥ��Υե����뤬 \f2extdocURL\fP �ǻ��ꤵ�줿���Ȥϰۤʤ��� (�̾\f2packageListLoc\fP �ǻ����ǽ�ʥ�����ʾ��) ��¸�ߤ���Ȥ���\f2\-linkoffline\fP ����Ѥ��ޤ����������äơ�\f2extdocURL\fP �� WWW ��Ǥ������������Ǥ��ʤ����ϡ�\f2\-linkoffline\fP ����ꤹ�뤳�Ȥˤ�ꡢ�ɥ�����Ȥ�������� javadoc �ġ��뤬 Web ���³�Ǥ��ʤ���Фʤ�ʤ��Ȥ������ʤ��ʤ�ޤ���
.LP
����ˡ��ɥ�����Ȥ����뤿��Ρ֥ϥå��פȤ��Ƥλ��Ѥ��ǽ�Ǥ����ѥå������Υ��å���Τ��Ф��� javadoc ��¹Ԥ������ȡ��ѹ���������Υѥå������������Ф��� javadoc ��¹Ԥ��ޤ����������ơ��������줿�ե�������ꥸ�ʥ�Υե����륻�åȤ����Ǥ���褦�ˤ��ޤ�����ȤǼ����ޤ���
.LP
.BR \-linkoffline
���ץ����ˤ� 2 �Ĥΰ������ޤ���1 �Ĥ�
<a href> ��������ʸ���⤦ 1 �Ĥ�
.BR package-list:
�θ��������ޤ���
.LP
.RS
.TP 2
\(bu
.I extdocURL
�ϡ�\f3javadoc\f1 �ˤ�ä�������졢����Ȥ��ƻ��ꤹ��
����ɥ�����Ȥ�����ǥ��쥯�ȥ�����
URL �ޤ������ URL �Ǥ��� ���Х�ξ�硢
������ǥ��쥯�ȥ� (\-d �ǻ���) �������Хѥ���
����ѥå������Υ롼�Ȥ��Ϥ�ɬ�פ�����ޤ��� �ܺ٤ϡ�
.B \-link
���ץ�����
.I extdocURL
�Ȥ��Ƥ���������
.TP 2
\(bu
.I packagelistLoc
�ˤϡ�����ɥ�����Ȥ�
.B package-list
�ե����뤬��äƤ���ǥ��쥯�ȥ�Υѥ��ޤ���
URL ����ꤷ�ޤ��� URL (http: �ޤ��� file:)
�ޤ��ϥե�����ѥ������Ǥ��ޤ���
�ޤ������Хѥ�����Хѥ��Τɤ���Ǥ⤫�ޤ��ޤ���
���Хѥ��ξ��ϡ�javadoc ���¹Ԥ���븽�ߤ�
�ǥ��쥯�ȥ꤫�����Хѥ��Ȥ��ƻ��ꤷ�ޤ���
.BR package-list
�Ȥ����ե�����̾�ϴޤ�ʤ��Ǥ���������
.LP
.B javadoc
�� 1 ��μ¹Ԥǡ�ʣ���
.B \-linkoffline
���ץ��������Ǥ��ޤ���
1.2.2 ����ΥС������Ǥϡ�ʣ��Υ��ץ����ϻ���Ǥ��ޤ���Ǥ�����
.LP
����ɥ�����Ȥؤ���Х��Ȥä��� -
.BR java.lang
��
.BR java.io
������Ӥ���¾�� Java 2 �ץ�åȥե�����ѥå����� (\f2http://java.sun.com/j2se/1.5.0/docs/api\fP)
�˥�������Ƥ⡢Web �˥��������Ǥ��ʤ�
���ˤĤ��ƹͤ��Ƥߤޤ���
.BR package-list
�ե������֥饦���dz��� (\f2http://java.sun.com/j2se/1.5.0/docs/api/package\-list\fP)��
������ǥ��쥯�ȥ����¸���ޤ���
���ˡ�2 ���ܤΰ���
.I packagelistLoc
�Ǥ��Υ����륳�ԡ�����ꤷ�ޤ������ΤȤ�
�ѥå������ꥹ�ȥե�����ϸ��ߤΥǥ��쥯�ȥ�
��.�פ���¸����Ƥ��ޤ��� ���Υ��ޥ�ɤϡ�
Java 2 �ץ�åȥե�����ѥå������ؤΥ��ޤࡢ
com.mypackage �ѥå������Υɥ�����Ȥ�����ޤ���
�������줿�ɥ�����Ȥˤϡ����Ȥ��Х��饹�ĥ���
Object ���饹�ؤΥ���ޤޤ�Ƥ��ޤ�
(\-sourcepath �ʤɤ�¾��ɬ�פʥ��ץ�����ɽ������ޤ���)��
.LP
.RS
.ft 3
.nf
% \fP\f3javadoc \-linkoffline http://java.sun.com/j2se/1.5.0/docs/api . com.mypackage\fP
.fi
.ft 1
.RE
.LP
����ɥ�����Ȥؤ���Х��Ȥä��� -
.B \-linkoffline
����Хѥ��ǻ��ꤹ��ΤϤ��ޤ����Ū�ǤϤ���ޤ����̾�ϡ�
.B \-link
�ǽ�ʬ������Ǥ���
.B \-linkoffline
����Ѥ��Ƥ����硢
.BR package-list
�ե�������̾������ǡ����Х����Ѥ��Ƥ�����ϡ�
����Υե�����������Ǥ���Τ����̤Ǥ���
���Τ��ᡢ
.B \-linkoffline
�� 2 �Ĥΰۤʤ���Υѥ���
Ϳ����ɬ�פϤ���ޤ��� 2 �Ĥΰ���Ʊ���Ǥ����硢
.B \-link
����ѤǤ��ޤ���
.B \-link
����Х�λ�����Ȥ��Ƥ���������
.LP
package-list �ե�����μ�ư�� -
.BR package-list
�ե����뤬�ޤ�¸�ߤ��ʤ��Ƥ⡢�ɥ�����ȤΥ���Υѥå�����̾���狼�äƤ�����ϡ����Υե�����Υ��ԡ���ʬ�Ǻ�����
.I packagelistLoc
�Ǥ��Υѥ�����ꤹ�뤳�Ȥ��Ǥ��ޤ���
com.apipackage ���ǽ�˺����줿�Ȥ���
com.spipackage �Υѥå������ꥹ�Ȥ�¸�ߤ��ʤ��ä���
����ξ�礬������Ǥ���
�����ˡ�ϡ��ѥå�����̾�Ϥ狼�äƤ����ΤΡ�
�ޤ���������Ƥ��ʤ�������������ɥ�����Ȥ˥����
�ɥ�����Ȥ�������������Ǥ���
�ޤ���Javadoc 1.0 �ޤ��� 1.1 �Ǥ� package-list �ե����뤬
��������ʤ����ᡢ�����ˡ�ǡ������ΥС�������
�������줿�ѥå������� package-list �ե��������Ǥ��ޤ���
2 �Ĥβ�Ҥ�̤������ package-list �ե������
��ͭ���뤳�Ȥ�Ǥ��뤿�ᡢ���������ꤷ��
�ɥ�����Ȥ�Ʊ���˥������뤳�Ȥ��ǽ�Ǥ���
.LP
ʣ��Υɥ�����Ȥ˥�� -
.B \-linkoffline
�ϡ�����������ɥ�����Ȥ��Ȥ� 1 �Ĥ��Ļ��ꤷ�ޤ���
������Ǥϡ��狼��䤹�����뤿���
���ץ���Ȥ˹Ԥ�ʬ���Ƥ��ޤ���
.LP
.RS
.ft 3
.nf
.ta 18n
% javadoc \-linkoffline docURL1 packagelistURL1 \\
\-linkoffline docURL2 packagelistURL2 \\
.ft 1
...
.fi
.RE
.LP
.B �ɥ�����Ȥι���:
.B \-linkoffline
���ץ����Τ⤦ 1 �Ĥ����Ӥϡ��ץ������Ȥ�¿��Υѥå�������Ȥ���
���Ǥ˥ĥ���Τ��Ф���
.B javadoc
��¹Ԥ��Ƥ�����ˡ����μ¹ԤǤϡ����Ф䤯�٤���
�ѹ���ԤʤäƤ��顢������
�ĥ�ΰ�����Ф��Ƥ���
.B javadoc
��¹Ԥ�ľ��������������Ǥ�������ϡ�
�ѹ����ɥ�����ơ�������Ȥ��Ф�
�ƤǤ��ꡢ�����˥�����Ф��ƤǤϤʤ����ˤ��������
��������Τǡ��ϥå���
�Τ褦�ʤ�ΤǤ��������������ɤ��Ф��ƥ����˥�����ɲá�
���ޤ����ѹ��������ϡ��������ѥå������ĥ��
�Ѿ��������ФΥꥹ�ȡ�[����] �ڡ����ʤɤξ��
�Dz��줿���ɽ������ޤ���
.LP
�ޤ����������¹ԤΤ��ᡢ������
������ǥ��쥯�ȥ� (update) ������ޤ������ꥸ�ʥ�������ǥ��쥯�ȥ�� html �Ȥ��ޤ�����äȤ��ñ����Ȥ��ơ�html �οƤ˰�ư���ޤ���
.B \-linkoffline
�� 1 ���ܤΰ���˸��ߤΥǥ��쥯�ȥ��.�פ�
���ꤷ��2 ���ܤΰ���� package-list
��������Ǥ��� html �ؤ���Хѥ�����ꤷ�ޤ��������������ѥå������Υѥå�����̾�Τߤ��Ϥ��ޤ���
.LP
.RS
.ft 3
.nf
% javadoc \-d update \-linkoffline . html com.mypackage
.fi
.ft 1
.RE
.LP
.B javadoc
�μ¹Ԥ���λ�����Ȥ���
.B update/com/package
���������줿���饹 (���פ����ǤϤʤ�) �ǡ�
html/com/package ��ˤ��륪�ꥸ�ʥ�Υե���������ԡ����ޤ���
.TP
\-linksource
�ƥ������ե����� (���ֹ��դ�) �� HTML �С������������ɸ�� HTML �ɥ�����Ȥ��饽�����ե�����ؤΥ���ɲä��ޤ�����ϡ��������ե�������������Ƥ��륯�饹�����ե����������ȥ饯������åɡ��ե�����ɤ��Ф��ƺ�����ޤ����ǥե���ȥ��ȥ饯�����������줿���饹���Ф��ƤϺ�����ޤ���
.LP
\f3���Υ��ץ����ϡ�\fP\f4\-public\fP\f3��\fP\f4\-package\fP\f3��\fP\f4\-protected\fP\f3��\fP\f4\-private\fP\f3 �γƥ��ץ����Ȥϴط��ʤ�������Υ��饹���ե�����ɡ�����Υ�åɤ����Τ�Ϥ���Ȥ���Ȥ߹��ޤ줿�������ե��������\fP\f4���٤Ƥ�\fP\f3�������ξܺ٤�����ޤ���\fP\f2\-private\fP ���ץ�������ꤷ�ʤ������ꡢ����Υ��饹�䥤�ե������ΰ���ˤϡ����𤷤ƥ��������Ǥ��ʤ����Ȥ�����ޤ���
.LP
�ƥ�ϡ��������μ��̻�̾�ξ�˺�����ޤ������Ȥ��С�\f2Button\fP ���饹�Υ����������ɥؤΥ�ϡ���Button�פȤ�����ξ�˺�����ޤ���
.nf
\f3
.fl
public class Button
.fl
extends Component
.fl
implements Accessible
.fl
\fP
.fi
Button ���饹�� \f2getLabel()\fP ��åɤΥ����������ɤؤΥ�ϡ���getLabel�פȤ�����ξ�˺�����ޤ���
.nf
\f3
.fl
public String getLabel()
.fl
\fP
.fi
.LP
.TP
.BI \-group " groupheading packagepattern:packagepattern:..."
���ץڡ�����ʣ��Υѥå����������Υ��롼�פ�ʬ����
���롼��ñ�̤�ɽ���
���ޤ����ƥ��롼�פϡ����줾���̤�
.B \-group
���ץ����ǻ��ꤷ�ޤ��������Υ��롼�פϡ�
���ޥ�ɹԤǻ��ꤷ�����ǥڡ�����
ɽ������ޤ����ѥå������ϡ�1 �ĤΥ��롼����Ǥ�
����ե��٥åȽ���¤٤��ޤ�����
.B \-group
���ץ����Ǥϡ�
.I packagepattern
���Υꥹ�Ȥ˰��פ���
�ѥå������������Ф�
.IR groupheading
��� 1 �Ĥ�ɽ�ˤޤȤ��ɽ������ޤ���
.RS
.TP 2
\(bu
.I groupheading
�ˤ�Ǥ�դΥƥ����Ȥ����Ǥ��������ޤ�뤳�Ȥ��Ǥ��ޤ���
���ꤷ���ƥ����Ȥϡ����롼�פ�ɽ���Ф��ˤʤ�ޤ���
.TP 2
\(bu
.I packagepattern
�ˤϡ�Ǥ�դΥѥå�����̾���ޤ���Ǥ�դΥѥå�����̾���Ƭ��ʬ�Ȥ����³�� 1 �ĤΥ������ꥹ�� (*)�����Ǥ��ޤ���
�������ꥹ���ϡ���Ǥ�դ�ʸ���˰��פ���פȤ�����̣�Υ磻��ɥ����ɤǤ����磻��ɥ����ɤȤ��Ƶ��Ƥ����Τϡ��������ꥹ�������Ǥ���1 �ĤΥ��롼�פˤϡ�
����� (:) �Ƕ�ڤä�ʣ��Υѥ������ޤ�뤳�Ȥ��Ǥ��ޤ���
.LP
��: �ѥ������ѥ�����ꥹ����ǥ������ꥹ����
�Ȥ����ϡ�"java.lang*:java.util"
�Τ褦�ˡ��ѥ�����ꥹ�Ȥ�����ǰϤ�ɬ�פ�����ޤ���
.LP
.B \-group
���ץ���� 1 �Ĥ���ꤵ��Ƥ��ʤ����ϡ����٤Ƥ�
�ѥå���������[�ѥå�����]
�Ȥ������Ф���� 1 �ĤΥ��롼�פ������ޤ���
�ɥ�����Ȳ������ѥå�������
��ˡ����ꤷ�����롼�פΤɤΥ��롼�פˤ����ʤ�
�ѥå������������硢���Τ褦��
�ѥå������� [����¾�Υѥå�����] �Ȥ������Ф���
������Ω�������롼�פ������ޤ���
.LP
���Ȥ��С����Τ褦�˥��ץ�������ꤹ��ȡ�
�ɥ�����Ȳ������ 4 �ĤΥѥå������ϡ�
�����ѥå���������ĥ��ǽ�ѥå�������
����Ӥ���¾�Υѥå�������ʬ����ޤ���
\f3java.lang*\f1 �Ǥϡ���³�ΥɥåȤ��ʤ����Ȥ�
��դ��Ƥ���������\f3java.lang.*\f1 �Τ褦�˥ɥåȤ�
����ȡ�
.B java.lang
�ѥå������ϴޤޤ�ʤ����Ȥˤʤ�ޤ���
.LP
.RS
.ft 3
.nf
% javadoc \-group "Core Packages" "java.lang*:java.util"
\-group "Extension Packages" "javax.*"
java.lang java.lang.reflect java.util javax.servlet java.new
.fi
.ft 1
.RE
.LP
���η�̡����Τ褦�ʥ��롼�ײ����Ԥ��ޤ���
.LP
.RS
.ft 3
.nf
Core Packages
java.lang
java.lang.reflect
java.util
Extension Packages
javax.servlet
Other Packages
java.new
.fi
.ft 1
.RE
.RE
.TP
.B \-nodeprecated
�侩����ʤ� API ��ɥ�����Ȥ�������뤳�Ȥ�ػߤ��ޤ���
����ϡ�
.B \-nodeprecatedlist
���ץ�������ꤷ������ư��˲ä��ơ�
�ɥ�����ȤΤۤ�����ʬ���̤��ơ�
�侩����ʤ� API ������ʤ����Ȥ�Ʊ���Ǥ���
���Υ��ץ����ϡ������ɤҤ��Ƥ��ơ�
�侩����ʤ������ɤ�̵�뤷������������Ǥ���
.TP
.B \-nodeprecatedlist
�侩����ʤ� API �Υꥹ�Ȥ�ޤ�
�ե����� (\f3deprecated-list.html\f1) �������ػ�
���ޤ����ޤ������Υڡ����ؤΥ��
�ʥӥ��������С���������뤳�Ȥ�ػߤ��ޤ���
���������ɥ�����ȤΤۤ�����ʬ�Ǥϡ�
�侩����ʤ� API �������³�Ԥ��ޤ�������
���ץ����ϡ��侩����ʤ� API �������������ɤ�
�ޤޤ�Ƥ��餺���ʥӥ��������С���
���ä���ȸ���������������Ǥ���
.TP
.B \-nosince
���������ɥ�����Ȥ��顢
.BR @since
�����˴�Ϣ������Since�ץ�������������ޤ���
.TP
.B \-notree
���������ɥ�����Ȥ��饯�饹����ӥ��ե�����
���ؤ��ά���ޤ��������Υڡ����ˤϡ��ʥӥ��������С��Ρ֥ĥ�ץܥ��饢�������Ǥ��ޤ���
�ǥե���ȤǤϡ����ؤ�������ޤ���
.TP
.B \-noindex
���������ɥ�����Ȥ��������ά���ޤ���
�ǥե���ȤǤϡ�
������������ޤ���
.TP
.B \-nohelp
�ƽ��ϥڡ����κǾ���ȺDz����
�ʥӥ��������С����� [�إ��] ���
��ά���ޤ���
.TP
.B \-nonavbar
���������ڡ����κǾ���ȺDz����ɽ�������
�ʥӥ��������С����إå���
����ӥեå��������ػߤ��ޤ���
���Υ��ץ����ϡ�bottom ���ץ����ˤϱƶ����ޤ���
.B \-nonavbar
���ץ����ϡ��������뤿������
�ե������ PostScript �ޤ��� PDF ���Ѵ�����
���ʤɡ����Ƥ��������פǥʥӥ���������
ɬ������ʤ���������Ǥ���
.TP
.BI \-helpfile " path/filename"
����Ȳ���Υʥӥ��������С��� [�إ��] ���
����Ȥʤ����إإ�ץե�����
.I path/filename
�Υѥ�����ꤷ�ޤ������Υ��ץ�����ꤵ��Ƥ��ʤ���硢
.B javadoc
�ϡ�javadoc �˥ϡ��ɥ����ɤ���Ƥ���إ�ץե�����
.B help-doc.html
��ưŪ�˺����ޤ������Υ��ץ�����Ȥ��С�
�ǥե���Ȥ������С��饤�ɤǤ�
�ޤ����ե�����̾�ˤϤɤΤ褦��
̾�������Ǥ���\f3help-doc.html\f1 �ˤϸ��ꤵ���
����
.B javadoc
�ϡ�����˽��äơ��ʥӥ��������С��ˤ���
���Ĵ����ä��ޤ���
��������ޤ���
.LP
.RS
.RS
.ft 3
.nf
% javadoc \-helpfile /home/doc/myhelp.html java.awt
.fi
.RE
.RE
.ft 1
.TP
.BI \-stylesheetfile " path/filename"
���� HTML �������륷���ȥե�����Υѥ�����ꤷ�ޤ���
���Υ��ץ�����ꤵ��Ƥ�
�ʤ���硢
.B javadoc
�ġ���ϡ�����Ū�˥ϡ��ɥ����ɤ���Ƥ���
�������륷���ȥե�����
.BR stylesheet.css
��ưŪ�˺����ޤ������Υ��ץ�����Ȥ��С�
�ǥե���Ȥ������С��饤�ɤǤ��ޤ���
filename �ˤϤɤ�ʥե�����̾�Ǥ����Ǥ���
.BR stylesheet.css
�ˤϸ��ꤵ��ޤ���
��������ޤ���
.LP
.RS
.RS
.ft 3
.nf
% javadoc \-stylesheetfile /home/user/mystylesheet.css com.mypackage
.fi
.ft 1
.RE
.RE
.TP
.B \-serialwarn
.B @serial
�������ʤ���硢����ѥ����˷ٹ������ޤ����ǥե���ȤǤϡ�
.B javadoc
1.2.2 (����Ӥ���ʹ�) ��
.B @serial
�ηٹ������ޤ���
(����ϡ�����ΥС������ȤϵդǤ���)
.B @serial
�ηٹ�������ˤϡ�
���Υ��ץ�������Ѥ��Ƥ������������Υ��ץ����ϡ��ǥե���Ȥ�
ľ��ǽ�ʥե�����ɤ� writeExternal ��åɤ����
�ɥ�����Ȳ�����Τ���Ω���ޤ���
.TP
.BI \-charset " name"
���Υɥ�������Ѥ� HTML ʸ�����åȤ���ꤷ�ޤ�������̾���ϡ�
.na
\f2IANA Registry\fP
.fi
(http://www.iana.org/assignments/character\-sets) ��Ϳ����줿���侩����� MIME ̾�Ǥʤ���Фʤ�ޤ���������ޤ���
.nf
\f3
.fl
% \fP\f3javadoc \-charset "iso\-8859\-1" mypackage\fP
.fl
.fi
��������뤹�٤ƤΥڡ������Ƭ�ˡ����ιԤ��������ޤ���
.nf
\f3
.fl
<META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1">
.fl
\fP
.fi
���� META �����ˤĤ��Ƥϡ�
.fi
http://www.w3.org/TR/REC\-html40/charset.html#h\-5.2.2
��
.na
\f2HTML ��ɸ��\fP (4197265 ����� 4137321) �Ȥ��Ƥ���������
.LP
\-encoding �� \-docencoding �⻲�Ȥ��Ƥ���������
.LP
.TP 3
\-docencoding\ name
��������� HTML �ե�����Υ����ǥ�����ꤷ�ޤ�������̾���ϡ�
.na
\f2IANA Registry\fP
.fi
(http://www.iana.org/assignments/character\-sets) ��Ϳ����줿���侩����� MIME ̾�Ǥʤ���Фʤ�ޤ����Υ��ץ������ά���ʤ��� \-encoding ����Ѥ�����硢��������� HTML �ե�����Υ����ɤϡ�\-encoding �ˤ�äƷ����ޤ�����������ޤ���
.nf
\f3
.fl
% \fP\f3javadoc \-docencoding "ISO\-8859\-1" mypackage\fP
.fl
.fi
\-encoding ����� \-charset �⻲�Ȥ��Ƥ���������
.LP
.TP 3
\-keywords
HTML �������ɥ������饹���Ȥ���������ե�������ɲä��ޤ��������Υ����ϡ�����������륵�������ڡ����Ĥ��������Ω���ޤ��������ͥå���Τ�����¿���Υ���������ϡ��ڡ��������������Ѥ��Ƥ��뤿�ᡢ�������Ĵ�٤ޤ�����������Ȥ� Web �����Ȥ˸��ꤷ�Ƥ����ȤǤϡ����������������Ĵ�٤뤳�Ȥˤ�äƥ��åȤ�����ޤ���
.LP
������ˤϡ����饹�δ�������̾�ȡ��ե�����ɤ���ӥ�åɤν�������Ƥ��ʤ�̾�����ޤޤ�ޤ������ȥ饯���ϡ����饹̾��Ʊ���Ǥ��뤿��ޤޤ�ޤ����Ȥ��С����饹 String �ϼ��Υ�����ɤdz��Ϥ��ޤ���
.nf
\f3
.fl
<META NAME="keywords" CONTENT="java.lang.String class">
.fl
<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">
.fl
<META NAME="keywords" CONTENT="length()">
.fl
<META NAME="keywords" CONTENT="charAt()">
.fl
\fP
.fi
.LP
.TP 3
\-tag\ \ tagname:Xaoptcmf:"taghead"
Javadoc �ġ��뤬�ɥ�����ơ����������ΰ���� 1 �ļ��ñ��ʥ�������֥�å����� \f2@\fP\f2tagname\fP ����Ǥ���褦�ˤ��ޤ�������ˤ�ꡢJavadoc �ġ���ϥ���̾�Ρ֥��ڥ����å��פ�Ԥ����Ȥ��Ǥ���Τǡ���������������Τ��٤ƤΥ������ॿ���� \f2\-tag\fP ���ץ�����Ȥ߹��ळ�Ȥ��ᤷ�ޤ�������μ¹Ԥǽ��Ϥ���ʤ������ϡ�\f2X\fP ���դ���̵���ˤ��ޤ���
.LP
����� (\f4:\fP) �Ͼ�˶�ڤ�ʸ���ˤʤ�ޤ���\f2tagname\fP �ǥ�������Ѥ���ˤϡ��֥���̾�ǤΥ����λ��ѡפȤ��Ƥ���������
.LP
\f2\-tag\fP ���ץ����ϡ������θ��Ф���\f2taghead\fP�פ�����ǽ��Ϥ��ޤ������μ��ιԤˤϡ����Υ��ץ����ΰ���ǻ��ꤷ���ƥ����Ȥ�³���ޤ����ʲ�����Ȥ��Ƥ����������֥�å�������Ʊ�͡����ΰ���Υƥ����Ȥˤϥ���饤����ޤ�뤳�Ȥ��Ǥ��ޤ������Υ���饤�����ᤵ��ޤ������Ϥϡ������ 1 �ļ��ɸ��Υ��� (\f2@return\fP��\f2@author\fP �ʤ�) �ν��ϤȤ褯���Ƥ��ޤ���\f2taghead\fP ���ά����ȡ�\f2tagname\fP �����Ф��Ȥ���ɽ������ޤ���
.LP
\f3����������\fP \- ����� \f4Xaoptcmf\fP ��ʬ�ϡ���������������Υ��������֤Ǥ�����֤ȡ�\f2X\fP ��ȤäƤ��Υ�����̵���ˤǤ��뤫�ɤ��������ꤷ�ޤ������������ְ��֤�¤��ʤ����� \f4a\fP ����ꤷ�ޤ�������ʳ���ʸ����Ȥ߹�碌���ǽ�Ǥ���
.br
\f4X\fP (������̵����)
.br
\f4a\fP (���٤Ƥΰ���)
.br
\f4o\fP (����)
.br
\f4p\fP (�ѥå�����)
.br
\f4t\fP (�����ʤ����饹����ӥ��ե�����)
.br
\f4c\fP (���ȥ饯��)
.br
\f4m\fP (��å�)
.br
\f4f\fP (�ե������)
.LP
���륿������ -
�����������ɤ�Ǥ�դξ��ǻ��ѤǤ���
�����Υ������ץ���������ޤ���
.LP
.RS
.TP 3
\-tag todo:a:"To Do:"
.RE
.LP
���ȥ饯������åɡ�����ӥե�����ɤ����� @todo ��
���Ѥ�����ˤϡ����Τ褦�ˤ��ޤ���
.LP
.RS
.ft 3
.nf
\-tag todo:cmf:"To Do:"
.fi
.ft 1
.RE
.LP
�嵭�Ǥϡ����Υ���� (:) ���ѥ�����
��ڤ국��ǤϤʤ���ɽ���ΤȤ��ꡢ
���Ф��ƥ����Ȥΰ���Ǥ��뤳�Ȥ���դ��Ƥ���������
���Τ褦�ˡ�@todo ������ޤॽ���������ɤ�
�ɤ��餫�Υ������ץ�������Ѥ��ޤ���
.LP
.RS
.ft 3
.nf
@todo The documentation for this method needs work.
.fi
.ft 1
.LP
����̾�˥�������Ѥ��� \-
����� (:) ��Хå�����å���ǥ��������פ���ȡ�
������̾�˻��Ѥ��뤳�Ȥ��Ǥ��ޤ���
.LP
.RS 5
.nf
/**
* @ejb:bean
*/
.RE
.fi
.LP
�Ǥ��Υ������ץ�������Ѥ���ȡ�
.LP
.RS 5
.nf
\-tag ejb\\:bean:a:"EJB Bean:"
.RE
.LP
�Ȥʤ�ޤ���
.fi
.ft 1
.RE
.LP
����̾�Υ��ڥ����å� (������̵����) - ��ȯ�Ԥϡ������������ɤ���ǽ��ϤǤ��ʤ��������ॿ������Ѥ��뤳�Ȥ�����ޤ������ξ�硢������������¸�ߤ��뤹�٤ƤΥ�����ꥹ�Ȥ������Ϥ��륿����ͭ�����������Ϥ��ʤ�������̵�������뤳�Ȥ����פǤ��� X ����Ѥ���ȥ�����̵�����Ǥ������줬�ʤ����ϥ�����ͭ���Ȥʤ�ޤ��� ����ʸ����¸�ߤˤ�äơ�
.B Javadoc
�ġ���ϡ����Ф���������̤�ΤΥ����ǡ������餯�֤�ְ㤤�Ǥ����Ƚ�ǤǤ��ޤ��� ���ξ�硢�ٹ��å�������ɽ������ޤ���
.LP
���Ǥ�¸�ߤ��롢���֤���ꤹ������ͤ� X ���ɲä�����硢������ͭ���ˤ������Ȥ��� X ����Ǥ��ޤ��� ���Ȥ��С�@todo �����Ϥ������ʤ������ξ�硢���Τ褦�ˤ��ޤ���
.LP
.RS
.ft 3
.nf
\-tag todo:Xcmf:"To Do:"
.fi
.ft 1
.RE
.LP
�ޤ��ϡ����Τ褦�ˤ���ñ�ˤ��뤳�Ȥ�Ǥ��ޤ���
.LP
.RS
.ft 3
.nf
\-tag todo:X
.fi
.ft 1
.RE
.LP
\-tag todo:X �ι�ʸ�ϡ�@todo ��������åȤ�
������Ƥ������ͭ���Ǥ���
.LP
�����ν� -
\-tag (����� \-taglet) ���ץ����ν��˽��ä�
���������Ϥ���ޤ��� �������ॿ����ɸ�ॿ����
���ߤ����뤳�Ȥ��Ǥ��ޤ��� ɸ�ॿ���Υ������ץ����ϡ�
������ꤹ�뤿�����Υץ졼���ۥ��Ǥ���
������ɸ�ॿ��̾��������Ѥ��ޤ�
(ɸ�ॿ���ξ����Ф����ѹ��Ǥ��ޤ���)��
�������˼����ޤ���
.LP
\-tag ���ʤ���硢\-taglet �ξ��ˤ�äƤ��ν�����ޤ�ޤ���
���� 2 �Ĥ�ξ�������ϡ����ޥ�ɹԤκǸ�˻��Ѥ��줿���
������ꤷ�ޤ� (����ϡ������ȥ�����åȤ���
���ޥ�ɹԤǻ��Ѥ��줿��˽������뤿��Ǥ�)��
���Ȥ��С�\-taglet �� \-tag ��ξ��Ȥ� todo �Ȥ���
̾���Ǥ����硢���ޥ�ɹԤκǸ�ǻ��Ѥ��줿
���������ꤷ�ޤ���
.LP
�����δ����ʥ��åȤ��� -
������Ǥϡ����Ϥ� Parameters �� Throws �δ֤�
To Do �������ޤ��� ��X�פ���Ѥ��ơ�@example ��
��������������κ���μ¹Ԥǽ��Ϥ���ʤ�������
���뤳�Ȥ����Ǥ��ޤ��� @argfile ����Ѥ���ȡ�
���Τ褦�˹Ԥη�³ʸ���ʤ��ǡ�
����ե�����ΰۤʤ�Ԥ˥��������֤Ǥ��ޤ���
.LP
.RS
.ft 3
.nf
\-tag param
\-tag return
\-tag todo:a:"To Do:"
\-tag throws
\-tag see
\-tag example:X
.fi
.ft 1
.RE
.LP
javadoc ���ɥ�����ơ�������Ȥ��Ϥ���ݤˡ�
���Ф��줿�����Τ�����ɸ�ॿ���Ǥ�ʤ���
\-tag �� \-taglet ���Ϥ���륿���Ǥ�ʤ���Τϡ�
����ʥ����Ȥ���ǧ�������ٹ𤬥�������ޤ���
.LP
ɸ�ॿ���ϡ��ǽ顢�ǥե���Ȥν���
�ꥹ������Ū�˳�Ǽ����ޤ���
\-tag ���ץ�������Ѥ���ȡ����Υ������ꥹ�Ȥ��ɲä���ޤ���
ɸ�ॿ���ϥǥե���Ȥΰ��֤����ư���ޤ���
���Τ��ᡢɸ�ॿ���� \-tag ���ץ����ά�����ȡ�
�ǥե���Ȥΰ��֤����֤��줿�ޤޤˤʤ�ޤ���
.LP
������ -
��ͭ�Υ͡��ॹ�ڡ�����٤���ʬ����ˤϡ�
�ѥå������˻��Ѥ���Ƥ��� com.mycompany.todo
�Ȥ���̾���Τ褦�ˡ��ɥå� (.) ���ڤ국��Ȥ���̾����Ȥ��ޤ���
Sun �Ϻ����ɥåȤ�ޤޤʤ�ɸ�ॿ��������ޤ���
�桼���������������ϡ�Sun ��������Ʊ��
̾���Υ�����ư����С��饤�ɤ��ޤ���
�Ĥޤꡢ�桼���� @todo �Ȥ���̾���Υ����ޤ���
������åȤ�����Ƥ�����硢���Τ��Ȥ� Sun ��
Ʊ��̾����ɸ�ॿ��������Ƥ⡢�桼����������
ư��Ϥ��Τޤްݻ�����ޤ���
.LP
\f3��� vs. Javadoc ����\fP \- ���̤ˡ��ɲä���ɬ�פΤ���ޡ������åפ����ɥ�����ơ������˱ƶ���Ϳ������ɥ�����ơ�������������ꤹ�뤿��Τ�ΤǤ����硢���Υޡ������åפ� javadoc �����ˤ��٤��Ǥ�������ʳ��ξ������ˤ��٤��Ǥ���
.na
��\f2Comparing Annotations and Javadoc Tags\fP��
.fi
(http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#annotations) �Ȥ��Ƥ���������
.LP
\-taglet ���ץ�������Ѥ��ơ����ʣ����
������ɥ�����䥫�����।��饤����
�����뤳�Ȥ��Ǥ��ޤ���
.TP
\-taglet class
�����Υɥ�����Ȥ�����˻Ȥ�������åȤ�ư���뤿���
���饹�ե��������ꤷ�ޤ���
���饹�δ�������̾����ꤷ�Ƥ���������
���Υ�����åȤϡ��������ॿ�������äƤ���ƥ����Ȱ����
��������ޤ��� ������åȤϤ����ΰ�������ꡢ
����������Ϥ�����ޤ��� ������åȤ���ξܺ٤ˤĤ��Ƥϡ�
������åȤγ��פȤ��Ƥ���������
.LP
������åȤϥ�����ɥ�����ޤ��ϥ���饤����
���Ѥ��������Ǥ��� ������åȤǤ�Ǥ�դ�
��ΰ����Ĥ��Ȥ��Ǥ������������ư������Ǥ��ޤ���
���Ȥ��С��ƥ����Ȥ�����ˤ����ꡢ�վ�����ˤ����ꡢ
�ƥ����Ȥ�ե�����˽Ф����ꡢ
¾�Υץ�����ư�����ꤹ�뤳�Ȥ��Ǥ���ΤǤ���
.LP
������åȤǻ���Ǥ���Τϡ����������־������ַ����ΤߤǤ�������¾�Τ��٤Ƥη���ϡ��ɥå���åȤˤ�äƹԤ��ޤ���������åȤ���Ѥ��Ƥ⡢��ޥ��饹�Υꥹ�Ȥ��饯�饹̾�������ʤɤν���ϼ¹ԤǤ��ޤ��������������Υƥ����Ȥ�ե�����˽��Ϥ����ꡢ�̤Υץ�����ȥꥬ����ʤɤ�����Ѥ�����ޤ���
.LP
������åȤؤΥѥ�����ꤹ��ˤϡ�
.B \-tagletpath
���ץ�������Ѥ��ޤ���
�������줿�ڡ����� Parameters �� Throws �δ֤�
To Do ������åȤ�����������ޤ���
.LP
.RS
.ft 3
.nf
\-taglet com.sun.tools.doclets.ToDoTaglet
\-tagletpath /home/taglets
\-tag return
\-tag param
\-tag todo
\-tag throws
\-tag see
.fi
.ft 1
.RE
.LP
.B \-taglet
���ץ�����
.B \-tag
���ץ���������˻��Ѥ��뤳�Ȥ�Ǥ��ޤ�����
���η�̡��ɤߤˤ����ʤ�ޤ���
.TP
\-tagletpath tagletpathlist
taglet ���饹�ե����� (.class) ��õ������θ����ѥ�����ꤷ�ޤ���
.I tagletpathlist
�ˤϡ������ (:) ��
��ڤä�ʣ��Υѥ���ޤ�뤳�Ȥ��Ǥ��ޤ���
.B Javadoc
�ġ���ϡ����ꤵ�줿�ѥ��ʲ��Τ��٤Ƥ�
���֥ǥ��쥯�ȥ�����ޤ���
.TP
\-docfilessubdirs
doc-files �ǥ��쥯�ȥ���γ��ؤ�ޤ�ƥ��ԡ�
�Ǥ���褦�ˤ��ޤ��� �Ĥޤꡢ���֥ǥ��쥯�ȥ�Ȥ��٤Ƥ�
����ƥ�Ĥ���������ǥ��쥯�ȥ�˺Ƶ�Ū�˥��ԡ�����ޤ���
���Ȥ��С�
.BR doc-files/example/images
�ǥ��쥯�ȥ�Ȥ�����Υե����뤬���ԡ�����ޤ���
���֥ǥ��쥯�ȥ������뤿��Υ��ץ����⤢��ޤ���
.TP
\-excludedocfilessubdirs name1:name2:...
doc-files �Υ��֥ǥ��쥯�ȥ�ǡ����ꤵ�줿
̾���Τ�Τ�����ޤ��� ���Υ��ץ�������Ѥ���ȡ�
SCCS ����Ӥ���¾�Υ����������ɴ����
���֥ǥ��쥯�ȥ�ԡ����ʤ��褦�ˤǤ��ޤ���
.TP
\-noqualifier all | packagename1:packagename2:...
�����ѥå�����̾���ϤΥ��饹̾�����������ޤ���
\-noqualifier ����
all (���٤ƤΥѥå����������Ҥ��)��
�ޤ��ϥ����Ƕ�ڤ�줿�ѥå������ꥹ�Ȥ�
�����줫�ǡ������ҤȤ��ƺ�����ޤ���
�磻��ɥ����ɤ���ѤǤ��ޤ���
�ѥå�����̾�ϥ��饹̾�ޤ��ϥ��ե�����̾��
ɽ�����줿�Ȥ����������ޤ���
.LP
������Ǥϡ����٤ƤΥѥå����������Ҥ��ά���ޤ���
.LP
.RS
.ft 3
.nf
\-noqualifier all
.fi
.ft 1
.RE
.LP
������Ǥϡ��ѥå����������� java.lang
����� java.io ���ά���ޤ���
.LP
.RS
.ft 3
.nf
\-noqualifier java.lang:java.io
.fi
.ft 1
.RE
.LP
������Ǥϡ�java ����� com.sun ����
�Ϥޤ� (javax ���)
���֥ѥå������Υѥå����������Ҥ�����ޤ���
.LP
.RS
.ft 3
.nf
\-noqualifier java.*:com.sun.*
.fi
.ft 1
.RE
.LP
�ѥå����������Ҥ��嵭��ư��˽��ä�ɽ��������硢̾����Ŭ�ڤ�û������ޤ����ܺ٤ϡ�̾����ɽ���ˡ�פȤ��Ƥ������������ε�§�ϡ�
\-noqualifier ��
���Ѥ���Ƥ��뤫�ɤ����ˤ�����餺¸�ߤ��ޤ���
.TP
.BI \-notimestamp
�����ॹ����פ��������ޤ���
�ƥڡ�����Ƭ��ˤ��롢�������줿 HTML ���
HTML �����Ȥǥ����ॹ����פ�������ޤ���
.B Javadoc
�� 2 �ĤΥ������١����Ǽ¹Ԥ����������Ф���
diff ��¹Ԥ���Ȥ��ˤ��Υ��ץ�������Ѥ���ȡ�
�����ॹ����פˤ�ä� diff ��ȯ�����ʤ��ʤ�Τ�
����Ǥ� (���Υ��ץ�������Ѥ��ʤ��ȡ�
�ƥڡ����� diff �ˤʤ�ޤ�)��
�����ॹ����פˤ�
.B Javadoc
�ΥС�������ֹ椬�ޤޤ�Ƥ��ꡢ
���Τ褦�ˤʤ�ޤ���
.LP
.RS 5
<!-- Generated by javadoc (build 1.5.0-internal)
on Tue Jun 22 09:57:24 PDT 2004 -->
.RE
.TP
\-nocomment
���Ҥ���Ӥ��٤ƤΥ�����ޤॳ����
��ʸ���Τ��������������������ޤ���
���Υ��ץ����ˤ�ꡢ���ϰۤʤ���Ū�Τ����ä�
�������ե���������Ѥ���
�������ץ������ȤΤ���Υ�����ȥ��
���Ǥ���褦�ˤʤ�ޤ�����
.SS ���ޥ�ɹ���ե�����
.BR javadoc
�Υ��ޥ�ɹԤ�û��������ʷ�ˤ����ꤹ�뤿��ˡ�
.BR javadoc
���ޥ�ɤ��Ф����� (\-J ���ץ������) ��
��ä� 1 �İʾ�Υե��������ꤹ�뤳�Ȥ��Ǥ��ޤ���
���Τ��Ȥ���Ѥ���С��ɤΥ��ڥ졼�ƥ������ƥ�
��Ǥ⡢Ǥ�դ�Ĺ����
.BR javadoc
���ޥ�ɤ���Ǥ��ޤ���
.LP
����ե�����ˤϡ�javac ���ץ����ȥ������ե�����̾��
��ͳ��Ȥ߹�碌�Ƶ��ҤǤ��ޤ���
�ޤ���Javadoc ���ץ������Ф�������Ҥ��Ƥ⤫�ޤ��ޤ���
�ե�������γư���ϡ�����ʸ���ޤ��ϲ��ԤǶ�ڤ�ޤ���
�ե�����̾�˶��ޤޤ�Ƥ�����ϡ����Υե�����̾���Τ���Ű�����ǰϤ�ɬ�פ�����ޤ���
.LP
.LP
����ե�������Υե�����̾�ϡ�
���ߤΥǥ��쥯�ȥ꤫�鸫�����Хѥ��ˤʤ�ޤ���
����ե�����ΰ��֤��鸫�����Хѥ��ǤϤ���ޤ���
����ե�������Υե�����̾�ꥹ�ȤǤϡ�
�磻��ɥ����� (*) �ϻ��ѤǤ��ޤ���
���Ȥ��С�*.java �Ȥϻ���Ǥ��ޤ���
����ե�������ΰ���� @ ʸ������Ѥ��ơ�
ʣ��Υե������Ƶ�Ū�˲�᤹�뤳�Ȥϥ��ݡ��Ȥ���Ƥ��ޤ���
�ޤ���\-J ���ץ����⥵�ݡ��Ȥ���Ƥ��ޤ���
���Υ��ץ����ϵ�ư�ġ�����Ϥ���ޤ�����
��ư�ġ���Ǥϰ���ե�����ݡ��Ȥ��Ƥ��ʤ�����Ǥ���
.LP
.BR javadoc
��¹Ԥ���Ȥ��ˡ��ư���ե�����Υѥ��ȥե�����̾��
��Ƭ�� @ ʸ�����դ����Ϥ��ޤ���
.BR javadoc
�ϡ�@ ʸ���ǻϤޤ���Ĥ���ȡ�
���Υե���������Ƥ�Ÿ�����ư���ꥹ�Ȥ������ޤ���
.LP
����ե������ 1 �Ļ��ꤹ����
.LP
argfile �Ȥ���̾���ΰ���ե�����ˤ��٤Ƥ�
Javadoc ������Ǽ�������Τ褦�˻��Ѥ��뤳�Ȥ��Ǥ��ޤ���
.LP
.RS
.ft 3
.nf
% javadoc @argfile
.fi
.ft 1
.RE
.LP
���ΰ���ե�����ˤϡ�������Ǽ�����Ƥ���
2 �ĤΥե���������Ƥ�ξ��Ȥ����뤳�Ȥ��Ǥ��ޤ���
.LP
����ե������ 2 �Ļ��ꤹ����
.LP
Javadoc ���ץ�����Ѥ� 1 �ġ��ѥå�����̾�ޤ��ϥ������ե�����̾�Ѥ�
1 �ĤȤ����褦�ˡ�2 �Ĥΰ���ե�����������
���Τ褦�ˤ��ƻ��Ѥ��뤳�Ȥ��Ǥ��ޤ���
�ʤ������Τ��ȤΥꥹ�ȤǤϡ��Ԥη�³ʸ������Ѥ��Ƥ��ޤ���
.LP
�ʲ������Ƥ�ޤ� options �Ȥ���̾���Υե����������ޤ���
.LP
.RS
.ft 3
.nf
\-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
.fi
.ft 1
.RE
.LP
�ʲ������Ƥ�ޤ� packages �Ȥ���̾���Υե����������ޤ���
.LP
.RS
.ft 3
.nf
com.mypackage1
com.mypackage2
com.mypackage3
.fi
.ft 1
.RE
.LP
���Τ��ȡ����Υ��ޥ�ɤ���Ѥ��� javadoc ��¹Ԥ��ޤ���
.LP
.RS
.ft 3
.nf
% javadoc @options @packages
.fi
.ft 1
.RE
.LP
�ѥ��դ��ΰ���ե��������
.LP
����ե�����ˤϡ��ѥ������Ǥ��ޤ���
�����������Υե�������˻��ꤵ�줿�ե�����̾�ϡ�
���ߤκ�ȥǥ��쥯�ȥ꤫�鸫�����Хѥ��ˤʤ�ޤ���
�Ĥޤꡢ������ξ��ϡ�path1 ��
path2 ���鸫�����Хѥ��ǤϤ���ޤ���
.LP
.RS
.ft 3
.nf
% javadoc @path1/options @path2/packages
.fi
.ft 1
.RE
.LP
���ץ����ΰ������
.LP
���ˡ�javadoc ���ץ������Ф���������ե������
��Ǽ��������ޤ��� �����Ǥϡ�\-bottom ���ץ�����
��˼��夲�ޤ������Υ��ץ����ˤϡ�
���ʤ�Ĺ���������ꤹ�뤳�Ȥ����뤫��Ǥ���
�ޤ������Υ��ץ����Υƥ����Ȱ���ˤʤ�
���Τ褦�����Ƥ�ޤࡢbottom �Ȥ���̾����
�ե����������ޤ���
.LP
'<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>'
.LP
���Τ��ȡ����Τ褦�ˤ���
.B javadoc
�ġ����¹Ԥ��ޤ���
.LP
.TP 3
% javadoc \-bottom @bottom @packages
.LP
�ޤ�������ե�������Ƭ��
\-bottom ���ץ�����Ȥ߹���Ǥ����С����Τ褦�ˤ��Ƽ¹ԤǤ��ޤ���
.LP
.RS
.ft 3
.nf
% javadoc @bottom @packages
.fi
.ft 1
.RE
.TP
.SH �¹�
.SS Javadoc �μ¹�
�С�������ֹ� -
.LP
javadoc �ΥС�������ֹ��
.BR javadoc \-J\-version
����Ѥ��뤳�Ȥdz�ǧ�Ǥ��ޤ���
ɸ��ɥå���åȤΥС�������ֹ�Ͻ��ϥ��ȥ���
ɽ������ޤ���
����� \-quiet ���ץ����ǥ��դˤǤ��ޤ���
.LP
�ץ���फ����ѤǤ��� public ���ե����� -
Java ����ǽ줿�ץ�����⤫��
.B javadoc
�ġ����ƤӽФ��ޤ���
���Υ��ե�������
.BR com.sun.tools.javadoc.Main
(javadoc �Ϻ��)
�ˤ���ޤ��� �ܺ٤ϡ���ɸ��ɥå���åȡ�
�Ȥ��Ƥ���������
.LP
\f3�ɥå���åȤμ¹�\fP \-
���������ϡ�ɸ�� HTML �ɥå���åȤ�ƤӽФ�����Τ�ΤǤ�����������ɥå���åȤ�ƤӽФ��ˤϡ�\-doclet ����� \-docletpath ���ץ�������Ѥ��ޤ�������Υɥå���åȤ�¹Ԥ�����������ˤĤ��Ƥϡ�
.na
��\f2Running the MIF Doclet\fP��
.fi
(http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html#runningmifdoclet) �Ȥ��Ƥ���������
.LP
.SH "������"
.B javadoc
�ϡ��ѥå��������Τ��Ф��Ƽ¹Ԥ��뤳�Ȥ⡢
�ġ��Υ������ե�������Ф��Ƽ¹Ԥ��뤳�Ȥ�
�Ǥ��ޤ����ƥѥå�����̾�ϡ����줾���
�ѥå�����̾���б�����ǥ��쥯�ȥ�̾��
�����ޤ���������Ǥϡ��������ե������
.BR /home/src/java/awt/*java
�ˤ���ޤ���������ǥ��쥯�ȥ��
.BR /home/html
�Ǥ���
.SS "1 �İʾ�Υѥå������Υɥ�����Ȳ�"
�ѥå�������ɥ�����Ȳ�����ˤϡ�����
�ѥå������Υ������ե����� (*\f3.java\f1)
�����ѥå�������Ʊ��̾����ĥǥ��쥯�ȥ�
���¸�ߤ��Ƥ��ʤ���Фʤ�ޤ���
�ѥå�����̾��ʣ��μ��̻Ҥǹ�������Ƥ���
(java.awt.color �Τ褦�ˡ��Ƽ��̻ҤϥɥåȤ�
��ڤ��Ƥ���) ���ϡ���³�γƼ��̻Ҥ����̤�
���֥ǥ��쥯�ȥ���б�����
���ʤ���Фʤ�ޤ��� (java/awt/color �ʤ�)��
1 �ĤΥѥå������Τ����ʣ��Υ������ե������
�ۤʤ���ˤ��� 2 �ĤΥǥ��쥯�ȥ�ĥ��ʬ����
��Ǽ���뤳�Ȥ��ǽ�Ǥ�
(
.BR src1/java/awt/color
��
.BR src2/java/awt/color
�ʤ�)��
�����������ξ��ϡ�\-sourcepath �ˤ�äơ�
����ξ��ξ�����ꤷ�ʤ���Фʤ�ޤ���
.LP
.B javadoc
��¹Ԥ���ˤϡ�cd ���ޥ�ɤ�Ȥä�
�ǥ��쥯�ȥ���ѹ����뤫��
�ޤ���
.B \-sourcepath
���ץ�������Ѥ��ޤ���
���줾�����˼����ޤ���
.TP 2
\(bu
.B ������ 1 - 1 �İʾ�Υѥå���������ε�ư��Ƶ�Ū�˼¹� -
������Ǥ� javadoc ��Ǥ�դΥǥ��쥯�ȥ꤫��¹ԤǤ���褦�ˡ�
.BR \-sourcepath
����Ѥ����Ƶ�Ū����Τ���� -subpackages (1.4 �ο����ץ����) ����Ѥ��ޤ��� ����ϡ�java �Υ��֥ѥå����� (
.BR java.net
�����
.BR java.lang
��롼�ȤȤ���ѥå��������) �������ޤ���
����ˤ�ä�
.BR java.lang.ref (
.BR java.lang
�Υ��֥ѥå�����) ��
��������뤳�Ȥ���դ��Ƥ���������
.LP
.RS
.ft 3
.nf
% javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude java.net:java.lang
.fi
.ft 1
.RE
.LP
¾�Υѥå������ĥ��������ˤϡ�
.BR java:javax:org.xml.sax
�Τ褦�ˡ�����̾����
.BR \-subpackages
������ɲä��ޤ���
.TP 2
\(bu
.B ������ 2 - �롼�ȥ������ǥ��쥯�ȥ�˰ܤäƤ������Ū�ʥѥå�������¹� -
���������ѥå�������
�ƥǥ��쥯�ȥ�˰�ư���ޤ���
���ˡ��ɥ�����Ȳ�����
1 �İʾ�Υѥå�����̾����ꤷ��
.BR javadoc
��¹Ԥ��ޤ���
.LP
.RS
.ft 3
.nf
% cd /home/src/
% javadoc \-d /home/html java.awt java.awt.event
.fi
.ft 1
.RE
.TP 2
\(bu
.B ������ 3 - Ǥ�դΥǥ��쥯�ȥ꤫��¹ԡ��������ե������ 1 �ĤΥǥ��쥯�ȥ�ĥ��ˤ��� - ���Υ������Ǥϡ����ߤΥǥ��쥯�ȥ꤬�ɤ��Ǥ��äƤ⤫�ޤ��ޤ��� �ȥåץ�٥�Υѥå������οƥǥ��쥯�ȥ��
.B \-sourcepath
�˻��ꤷ���ɥ�����Ȳ����� 1 �İʾ�Υѥå�����̾����ꤷ�ơ�
.B javadoc
��¹Ԥ��ޤ���
.LP
.RS
.ft 3
.nf
% javadoc -d /home/html -sourcepath /home/src java.awt java.awt.event
.fi
.ft 1
.RE
.TP 2
\(bu
.B ������ 4 - Ǥ�դΥǥ��쥯�ȥ꤫��¹ԡ��������ե������ʣ��Υǥ��쥯�ȥ�ĥ��ˤ��� - ����ϥ����� 3 �Ȼ��Ƥ��ޤ������ѥå�������ʣ��Υǥ��쥯�ȥ�ĥ��¸�ߤ��ޤ��� �ƥĥ�Υ롼�ȤؤΥѥ���
.B \-sourcepath
�˻��ꤷ (�����Ƕ�ڤ�)���ɥ�����Ȳ����� 1 �İʾ�Υѥå�����̾����ꤷ�ơ�javadoc ��¹Ԥ��ޤ��� 1 �ĤΥѥå������Τ��٤ƤΥ������ե����뤬��1 �ĤΥ롼�ȥǥ��쥯�ȥ�β���¸�ߤ��ʤ���Фʤ�ʤ����Ȥ������ȤϤ���ޤ��������ѥ��Ȥ��ƻ��ꤵ�줿���Τɤ����Ǹ��դ���н�ʬ�Ǥ���
.LP
.RS
.ft 3
.nf
% javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java.awt java.awt.event
.fi
.ft 1
.RE
.LP
���: �ɤ���Υ������Ǥ⡢�ѥå�����
.B java.awt
��
.B java.awt.event
�� public ����� protected
�ʥ��饹�ȥ��ե��������оݤˡ�HTML ������
�ɥ�����Ȥ��������졢����
���줿������ǥ��쥯�ȥ� (\f3/home/html\f1) �� HTML �ե����뤬
��¸����ޤ���2 ��
�ʾ�Υѥå����������������Τǡ��ɥ�����Ȥϡ�
�ѥå������Υꥹ�ȡ����饹�Υꥹ�ȡ�
����ӥᥤ��ڡ����� 3 �ĤΥե졼���Ĥ��Ȥˤʤ�ޤ���
.SS "1 �İʾ�Υ��饹�Υɥ�����Ȳ�"
.B javadoc
�ġ����¹Ԥ��� 2 ���ܤ��ˡ�ϡ�1 �İʾ�Υ������ե����� (
.B .java
) ���Ϥ����ȤǤ���
.B javadoc
�ϡ����� 2 �ĤΤɤ��餫���ˡ�Ǽ¹ԤǤ��ޤ���
1 �Ĥϡ�(cd �ˤ�ä�) �ǥ��쥯�ȥ��
�ѹ������ˡ���⤦ 1 �Ĥ�
.B .java
�ե�����ؤΥѥ�������ꤹ���ˡ�Ǥ���
���Хѥ��ϡ����ߤΥǥ��쥯�ȥ꤫�����Хѥ��Ǥ���
�������ե�������Ϥ�����硢
.B \-sourcepath
���ץ�����̵�뤵��ޤ���
�������ꥹ�� (*) ��
�褦�ʥ��ޥ�ɹԥ磻��ɥ����ɤ���Ѥ���ȡ�
���饹�Υ��롼�פ����Ǥ��ޤ���
.TP 2
\(bu
.B ������ 1 �������ǥ��쥯�ȥ�ؤΰ�ư:
.B .java
�ե�����Τ���ǥ��쥯�ȥ�˰�ư���ޤ���
���ˡ��ɥ�����Ȳ����� 1 �İʾ��
�������ե������̾������ꤷ��
.BR javadoc
��¹Ԥ��ޤ���
.LP
.RS
.ft 3
.nf
% cd /home/src/java/awt
% javadoc \-d /home/html Button.java Canvas.java Graphics*.java
.fi
.ft 1
.RE
.LP
.RS 2
������Ǥϡ����饹 Button �� Canvas��
������Ƭ�� Graphics �ǻϤޤ륯�饹��
HTML �����Υɥ�����Ȥ���������ޤ���
.BR javadoc
�ΰ���Ȥ����Ϥ���Ƥ���Τϡ�
�ѥå�����̾�ǤϤʤ��������ե�����ʤΤǡ�
�ɥ�����Ȥϡ����饹�Υꥹ�Ȥ�
�ᥤ��ڡ����� 2 �ĤΥե졼���Ĥ��Ȥˤʤ�ޤ���
.RE
.TP 2
\(bu
.B ������ 2 �ѥå������Υ롼�ȥǥ��쥯�ȥ�ؤΰ�ư:
����ϡ�Ʊ���롼����ˤ���ʣ��Υ��֥ѥå������Υ������ե������ġ���
�ɥ�����Ȳ������������Ǥ����ѥå�������
�롼�ȥǥ��쥯�ȥ�˰�ư�����ƥ������ե������
�롼�Ȥ���Υѥ��ǻ��ꤷ�ޤ���
.LP
.RS
.ft 3
.nf
% cd /home/src/
% javadoc \-d /home/html java/awt/Button.java java/applet/Applet.java
.fi
.ft 1
.RE
.LP
.RS 2
������Ǥϡ�Button ���饹����� Applet ���饹
�Ѥ� HTML �����Υɥ������
����������ޤ���
.RE
.TP 2
\(bu
.B ������ 3 ���٤ƤΥǥ��쥯�ȥ꤫��:
���Υ������Ǥϡ����ߤΥǥ��쥯�ȥ꤬�ɤ�
�ǥ��쥯�ȥ�Ǥ�����Ϥ���ޤ���
�ɥ�����Ȳ�����
.B .java
�ե�����ؤ���Хѥ��ޤ���
���Хѥ�����ꤷ��
.BR javadoc
��¹Ԥ��ޤ���
.LP
.RS
.ft 3
.nf
% javadoc \-d /home/html /home/src/java/awt/Button.java /home/src/java/awt/Graphics*.java
.fi
.ft 1
.RE
.LP
.RS 2
������Ǥϡ����饹
.B Button
������Ƭ��
.BR Graphics
�ǻϤޤ륯�饹�� HTML ����
�Υɥ�����Ȥ���������ޤ���
.RE
.SS "�ѥå������ȥ��饹�Υɥ�����Ȳ�"
�ѥå��������Τȸġ��Υ��饹��Ʊ���˥ɥ������
���Ǥ��ޤ������˼����Τϡ���˼�
���� 2 �Ĥ����Ȥ߹�碌����Ǥ���
.B \-sourcepath
�ϡ��ѥå������ؤΥѥ����Ф��Ƥϻ��ѤǤ��ޤ�����
�ġ��Υ��饹�Υѥ����Ф��Ƥϻ���
�Ǥ��ޤ���
.LP
.RS
.ft 3
.nf
% javadoc \-d /home/html \-sourcepath /home/src java.awt /home/src/java/applet/Applet.java
.fi
.ft 1
.RE
.LP
������Ǥϡ��ѥå�����
.B java.awt
�ȥ��饹
.B Applet
�� HTML �����Υɥ�����Ȥ�
��������ޤ���
.B javadoc
�ϡ�Applet �Υѥå�����̾��
.B Applet.java
�������ե�������Υѥå�������� (����������) ������ꤷ�ޤ���
.SS "������"
.B javadoc
�ġ���ˤϡ�¿��������ʥ��ץ�����ꡢ
������Τ����Ĥ��ϡ��ۤ��Υ��ץ�������褯
�Ȥ��ޤ����ʲ��ϡ�makefile �ѿ��Ȥä� Java �ץ�å�
�ե����� API ���
.B javadoc
�ġ����¹Ԥ��뤿��˻Ȥ�����Ū�ʥ��ޥ�ɤǤ���
�����Ǥ� 180M �Х��ȤΥ������Ѥ��ơ�
Java 2 Platform, Standard Edition, v1.2 ��
¸�ߤ��롢�� 1500 �Ĥ� public ����� protected
���饹�ˤĤ��ƥɥ�����Ȥ�����ޤ���
.LP
Ʊ����� 2 ��Ǻܤ��ޤ����ǽ����ϥ��ޥ�ɹԤ���¹Ԥ����Τǡ�2 ���ܤ���� Makefile ����¹Ԥ����ΤǤ��� ���ץ����ΰ������Хѥ�����Ѥ��Ƥ��뤿�ᡢǤ�դΥǥ��쥯�ȥ꤫�餳��
.B javadoc
���ޥ�ɤ�¹ԤǤ��ޤ���
.SS ���ޥ�ɹԤ���
���Υ��ޥ�ɹԤ���� 900 ʸ����Ķ���Ƥ��뤿�ᡢ
DOS �ʤɤΥ�����ˤ��礭�����ޤ���
������¤����ˤϡ����ޥ�ɹ�
����ե��������Ѥ��ޤ���
�ޤ��ϡ������륹����ץȤҤ��ޤ���
.LP
.nf
\f3
.fl
% javadoc \-sourcepath /java/jdk/src/share/classes \\
.fl
\-overview /java/jdk/src/share/classes/overview.html \\
.fl
\-d /java/jdk/build/api \\
.fl
\-use \\
.fl
\-splitIndex \\
.fl
\-windowtitle 'Java 2 Platform 5.0 API Specification' \\
.fl
\-doctitle 'Java<sup><font size="\-2">TM</font></sup> 2 Platform 5.0 API Specification' \\
.fl
\-header '<b>Java 2 Platform </b><br><font size="\-1">5.0</font>' \\
.fl
\-bottom '<font size="\-1"><a href="http://java.sun.com/cgi\-bin/bugreport.cgi">Submit
.fl
a bug or feature</a><br><br>Java is a trademark or registered trademark of Sun Microsystems,
.fl
Inc. in the US and other countries.<br>Copyright 1993\-1999 Sun Microsystems, Inc.
.fl
901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A. All Rights Reserved.</font>' \\
.fl
\-group "Core Packages" "java.*:com.sun.java.*:org.omg.*" \\
.fl
\-group "Extension Packages" "javax.*" \\
.fl
\-J\-Xmx180m \\
.fl
@packages
.fl
\fP
.fi
.LP
.LP
�嵭�Υ��ޥ�ɤǡ�packages �ϡ�
����оݤΥѥå�����̾ (
.BR java.applett
.BR java.lang �ʤ�) ��
��äƤ���ե������̾���Ǥ��� �ƥ��ץ����Ρ�
ñ������ǰϤޤ줿�������¦�ˤϡ�
����ʸ�������Ǥ��ޤ��� ���Ȥ��С�
������ԡ����ڡ����Ȥ�����ϡ�
.B \-bottom
���ץ������ʸ��������Ƥ���������
����ˡ����Τ��ȤΡ���פ⻲�Ȥ��Ƥ���������
.SS Makefile ����
�����Ǥϡ�GNU Makefile ������ޤ���
Windows �� Makefile ����ˤĤ��Ƥϡ�
.na
��\f2creating a makefile for Windows\fP��
.fi
(http://java.sun.com/j2se/javadoc/faq/index.html#makefiles) �Ȥ��Ƥ���������
.LP
.nf
\f3
.fl
javadoc \-\fP\f3sourcepath\fP\f3 $(SRCDIR) \\ /* Sets path for source files */
.fl
\-\fP\f3overview\fP\f3 $(SRCDIR)/overview.html \\ /* Sets file for overview text */
.fl
\-\fP\f3d\fP\f3 /java/jdk/build/api \\ /* Sets destination directory */
.fl
\-\fP\f3use\fP\f3 \\ /* Adds "Use" files */
.fl
\-\fP\f3splitIndex\fP\f3 \\ /* Splits index A\-Z */
.fl
\-\fP\f3windowtitle\fP\f3 $(WINDOWTITLE) \\ /* Adds a window title */
.fl
\-\fP\f3doctitle\fP\f3 $(DOCTITLE) \\ /* Adds a doc title */
.fl
\-\fP\f3header\fP\f3 $(HEADER) \\ /* Adds running header text */
.fl
\-\fP\f3bottom\fP\f3 $(BOTTOM) \\ /* Adds text at bottom */
.fl
\-\fP\f3group\fP\f3 $(GROUPCORE) \\ /* 1st subhead on overview page */
.fl
\-\fP\f3group\fP\f3 $(GROUPEXT) \\ /* 2nd subhead on overview page */
.fl
\-\fP\f3J\fP\f3\-Xmx180m \\ /* Sets memory to 180MB */
.fl
java.lang java.lang.reflect \\ /* Sets packages to document */
.fl
java.util java.io java.net \\
.fl
java.applet
.fl
.fl
WINDOWTITLE = 'Java 2 Platform v1.2 API Specification'
.fl
DOCTITLE = 'Java<sup><font size="\-2">TM</font></sup> 2 Platform v1.2 API Specification'
.fl
HEADER = '<b>Java 2 Platform </b><br><font size="\-1">v1.2</font>'
.fl
BOTTOM = '<font size="\-1"><a href="http://java.sun.com/cgi\-bin/bugreport.cgi">Submit
.fl
a bug or feature</a><br><br>Java is a trademark or registered trademark
.fl
of Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993\-1999
.fl
Sun Microsystems, Inc. 901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A.
.fl
All Rights Reserved.</font>'
.fl
GROUPCORE = '"Core Packages" "java.*:com.sun.java.*:org.omg.*"'
.fl
GROUPEXT = '"Extension Packages" "javax.*"'
.fl
SRCDIR = '/java/jdk/1.2/src/share/classes'
.fl
\fP
.fi
.LP
.LP
Makefile �ΰ���ϡ�ñ������ǰϤߤޤ���
.SS ��
.TP 2
\(bu
.B \-windowtitle
���ץ������ά����ȡ�
.B Javadoc
�ġ���ˤ�äƥɥ�����ȥ����ȥ뤬
������ɥ������ȥ�˥��ԡ�����ޤ���
.B \-windowtitle
�Υƥ����Ȥϡ�����Ū��
.B \-doctitle
��Ʊ���Ǥ�����������HTML �����ϻ��Ѥ��ޤ���
HTML �����ϡ�������ɥ������ȥ�ˤ��Τޤޤ�
�ƥ����ȤȤ���ɽ������Ƥ��ޤ��ޤ���
.TP 2
\(bu
������Τ褦��
.B \-footer
���ץ������ά����ȡ�
.B Javadoc
�ġ���ˤ�äƥإå��ƥ����Ȥ�
�եå��˥��ԡ�����ޤ���
.TP 2
\(bu
������Ǥ�ɬ�פ���ޤ���
.B \-classpath
�����
.BR \-link
����פʥ��ץ����Ǥ���
.LP
.SH �ȥ�֥륷�塼�ƥ���
.SS ����Ū�ʥȥ�֥륷�塼�ƥ���
.TP 2
\(bu
Javadoc FAQ - �褯����Ȥʤ�Х���
�ȥ�֥륷�塼�ƥ���
�ҥ�Ȥ�
.na
��\f2Javadoc FAQ\fP��
.fi
(http://java.sun.com/j2se/javadoc/faq/index.html#B) �ˤ���ޤ���
.TP 2
\(bu
�Х��������»��� - �ޤ����Х��ΰ���ϡ�
.na
��\f2Important Bug Fixes and Changes\fP��
.fi
(http://java.sun.com/j2se/1.5.0/fixedbugs/index.html) �Ǥ⻲�ȤǤ��ޤ���
.TP 2
\(bu
�С�������ֹ� - �С�������ֹ�Ȥ��Ƥ���������
.TP 2
\(bu
ͭ���ʥ��饹������ɥ�����Ȳ� -
javadoc ���ѥå�������ɥ�����Ȳ�����Ȥ���
ͭ���ʥ��饹̾�ǹ�������Ƥ���ե���������
�ɤ߹���褦�ˤʤ�ޤ�����
�ե�����̾�˥ϥ��ե� (-) �ʤɤ�ޤ�뤳�Ȥǡ�
javadoc ���ե�������Ϥ��ʤ��褦�ˤǤ��ޤ���
.SS ���顼�ȷٹ�
���顼��å���������ӷٹ��å������ˤϡ�
�ե�����̾����Ԥ��Ф�����ֹ椬
�ޤޤ�ޤ�����doc �����Ȥ������
�Ԥ��Ф�����ֹ�ϴޤޤ�ޤ���
.TP 2
\(bu
"error: cannot read: Class1.java" -
.B Javadoc
�ġ���ϸ��ߤΥǥ��쥯�ȥ��
.BR Class1.java
���饹���ɤ߹��⤦�Ȥ��Ƥ��ޤ���
���饹̾�ϡ����Хѥ��ޤ�����Хѥ���ɽ������ޤ���
���ξ�硢./Class1.java ��Ʊ���Ǥ���
.LP
.SH "��"
.TP 20
.SB CLASSPATH
�Ķ��ѿ�ϡ�
.B javadoc
���桼�����饹�ե������õ���Ȥ��˻Ȥ����ѥ�����ꤷ�ޤ����Ķ��ѿ�ϡ�
.B \-classpath
���ץ����ˤ�äƥ����С��饤�ɤ���ޤ����ǥ��쥯�ȥ��
������ʬ�䤷�ޤ������Ȥ��С�
���ΤȤ���Ǥ���
.RS 15
.sp 1n
.B .:/home/classes:/usr/local/java/classes
.RE
.br
.ne 11
.SH "��Ϣ����"
.LP
.RS 3
.TP 2
o
javac
.TP 2
o
java
.TP 2
o
jdb
.TP 2
o
javah
.TP 2
o
javap
.TP 2
o
.fi
http://java.sun.com/j2se/javadoc/index.jsp
��
.na
��\f2Javadoc Home Page\fP��
.TP 2
o
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
��
.na
��\f2How to Write Doc Comments for Javadoc\fP��
.TP 2
o
���饹�ѥ������
.TP 2
o
javac �� javadoc �����饹�������ˡ (tools.jar)
.RE
.LP
.LP
Javadoc �ϡ�Sun Microsystems, Inc �ξ�ɸ�Ǥ� (\f2javadoc\fP ���ޥ�ɼ��ΤˤϾ�ɸ����ܥ������)��
Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists