diff -r dc0feb520d54 -r 91b22707521a jdk/src/solaris/doc/sun/man/man1/javadoc.1 --- a/jdk/src/solaris/doc/sun/man/man1/javadoc.1 Mon Jul 27 19:50:14 2015 +0200 +++ b/jdk/src/solaris/doc/sun/man/man1/javadoc.1 Mon Jul 27 16:49:10 2015 -0700 @@ -1,53 +1,52 @@ '\" t -.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. -.\" -.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -.\" -.\" This code is free software; you can redistribute it and/or modify it -.\" under the terms of the GNU General Public License version 2 only, as -.\" published by the Free Software Foundation. -.\" -.\" This code is distributed in the hope that it will be useful, but WITHOUT -.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -.\" version 2 for more details (a copy is included in the LICENSE file that -.\" accompanied this code). -.\" -.\" You should have received a copy of the GNU General Public License version -.\" 2 along with this work; if not, write to the Free Software Foundation, -.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -.\" -.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -.\" or visit www.oracle.com if you need additional information or have any -.\" questions. -.\" +.\" Copyright (c) 1994, 2015, Oracle and/or its affiliates. All rights reserved. +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" .\" Arch: generic .\" Software: JDK 8 -.\" Date: 10 May 2011 +.\" Date: 03 March 2015 .\" SectDesc: Basic Tools .\" Title: javadoc.1 .\" .if n .pl 99999 -.TH javadoc 1 "10 May 2011" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- +.TH javadoc 1 "03 March 2015" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH NAME javadoc \- Generates HTML pages of API documentation from Java source files\&. @@ -209,7 +208,7 @@ \f3package java\&.lang\&.applet;\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -251,7 +250,7 @@ \f3initialize, start, and stop the applet\&. \fP .fi .nf -\f3\fR +\f3\fP .fi .nf \f3@since 1\&.0 \fP @@ -266,7 +265,7 @@ \f3\fP .fi .nf -\f3\fR +\f3\fP .fi .sp The \f3package\&.html\fR file is a typical HTML file and does not include a package declaration\&. The content of the package comment file is written in HTML with one exception\&. The documentation comment should not include the comment separators \f3/**\fR and \f3*/\fR or leading asterisks\&. When writing the comment, make the first sentence a summary about the package, and do not put a title or any other text between the \f3\fR tag and the first sentence\&. You can include package tags\&. All block tags must appear after the main description\&. If you add an \f3@see\fR tag in a package comment file, then it must have a fully qualified name\&. @@ -334,7 +333,7 @@ \f3 */\fP .fi .nf -\f3\fR +\f3\fP .fi .sp .SS TEST\ AND\ TEMPLATE\ FILES @@ -350,7 +349,7 @@ \f3com/package1/test\-files/\fP .fi .nf -\f3\fR +\f3\fP .fi .sp If your test files contain documentation comments, then you can set up a separate run of the \f3javadoc\fR command to produce test file documentation by passing in their test source file names with wild cards, such as \f3com/package1/test-files/*\&.java\fR\&. @@ -560,7 +559,7 @@ \f3implements Serializable\fP .fi .nf -\f3\fR +\f3\fP .fi .sp The declaration for the \f3Boolean\&.valueOf\fR method is: @@ -569,7 +568,7 @@ \f3public static Boolean valueOf(String s)\fP .fi .nf -\f3\fR +\f3\fP .fi .sp The \f3javadoc\fR command can include the modifiers \f3public\fR, \f3protected\fR, \f3private\fR, \f3abstract\fR, \f3final\fR, \f3static\fR, \f3transient\fR, and \f3volatile\fR, but not \f3synchronized\fR or \f3native\fR\&. The \f3synchronized\fR and \f3native\fR modifiers are considered implementation detail and not part of the API specification\&. @@ -593,7 +592,7 @@ \f3 */\fP .fi .nf -\f3\fR +\f3\fP .fi .sp To save space you can put a comment on one line: @@ -602,7 +601,7 @@ \f3/** This comment takes up only one line\&. */\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -623,19 +622,19 @@ \f3 */\fP .fi .nf -\f3\fR +\f3\fP .fi .nf \f3import com\&.example; // MISTAKE \- Important not to put import statement here\fP .fi .nf -\f3\fR +\f3\fP .fi .nf \f3public class Whatever{ }\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -657,7 +656,7 @@ \f3 */\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -676,7 +675,7 @@ \f3 */\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -700,7 +699,7 @@ \f3 */\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -730,7 +729,7 @@ \f3public int x, y; // Avoid this \fP .fi .nf -\f3\fR +\f3\fP .fi .sp The \f3javadoc\fR command generates the following documentation from the previous code: @@ -739,7 +738,7 @@ \f3public int x\fP .fi .nf -\f3\fR +\f3\fP .fi .sp The horizontal and vertical distances of point (x, y)\&. @@ -748,7 +747,7 @@ \f3public int y\fP .fi .nf -\f3\fR +\f3\fP .fi .sp The horizontal and vertical distances of point (x, y)\&. @@ -872,7 +871,7 @@ \f3 */\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -899,11 +898,10 @@ .TP 0.2i \(bu In the text arguments of the \f3@return\fR, \f3@param,\fR and \f3@throws\fR tags of a method\&. In this case, the tag text is copied from the corresponding tag up the hierarchy\&. -.RE -.RS +.RE + + See Method Comment Inheritance for a description of how comments are found in the inheritance hierarchy\&. Note that if this tag is missing, then the comment is or is not automatically inherited according to rules described in that section\&. - -.RE .TP {@link \fIpackage\&.class#member label\fR} Introduced in JDK 1\&.2 @@ -920,7 +918,7 @@ \f3Use the {@link #getComponentAt(int, int) getComponentAt} method\&.\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -931,7 +929,7 @@ \f3Use the getComponentAt method\&.\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -942,7 +940,7 @@ \f3Use the getComponentAt method\&.\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -982,7 +980,7 @@ \f3}\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -1014,7 +1012,7 @@ \f3}\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -1071,7 +1069,7 @@ \f3 */\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -1091,7 +1089,7 @@ \f3\fP .fi .nf -\f3\fR +\f3\fP .fi .sp @@ -1128,7 +1126,7 @@ \f3@see #constructor(Type argname, Type argname,\&.\&.\&.) \fP .fi .nf -\f3\fR +\f3\fP .fi .nf \f3\fIReferencing another class in the current or imported packages\fR\fP @@ -1155,7 +1153,7 @@ \f3@see Class \fP .fi .nf -\f3\fR +\f3\fP .fi .nf \f3\fIReferencing an element in another package (fully qualified)\fR\fP @@ -1185,7 +1183,7 @@ \f3@see package\fP .fi .nf -\f3\fR +\f3\fP .fi .sp \f3\fRNotes about the previous listing: @@ -1215,7 +1213,7 @@ Any enclosing classes and interfaces searching the closest first\&. .TP 0.4i 3\&. -Any superclasses and superonterfaces, searching the closest first\&. +Any superclasses and superinterfaces, searching the closest first\&. .TP 0.4i 4\&. The current package\&. @@ -1307,7 +1305,7 @@ \f3@see "The Java Programming Language" // "The Java Programming Language" \fP .fi .nf -\f3\fR +\f3\fP .fi .sp \fINote:\fR You can extend the \f3@se\fR\f3e\fR tag to link to classes not being documented with the \f3-link\fR option\&. @@ -1317,7 +1315,7 @@ Used in the documentation comment for a default serializable field\&. See Documenting Serializable Fields and Data for a Class at http://docs\&.oracle\&.com/javase/8/docs/platform/serialization/spec/serial-arch\&.html#5251 -See also Oracle\(cqs Criteria for Including Classes in the Serialilzed Form Specification at http://www\&.oracle\&.com/technetwork/java/javase/documentation/serialized-criteria-137781\&.html +See also Oracle\(cqs Criteria for Including Classes in the Serialized Form Specification at http://www\&.oracle\&.com/technetwork/java/javase/documentation/serialized-criteria-137781\&.html An optional \f3field-description\fR should explain the meaning of the field and list the acceptable values\&. When needed, the description can span multiple lines\&. The standard doclet adds this information to the serialized form page\&. See Cross-Reference Pages\&. @@ -1331,13 +1329,12 @@ .TP 0.2i \(bu A private or package-private class that implements \f3Serializable\fR is excluded unless that class (or its package) is marked with the \f3@serial include\fR tag\&. -.RE -.RS +.RE + + For example, the \f3javax\&.swing\fR package is marked with the \f3@serial\fR\f3exclude\fR tag in package\&.html or package-info\&.java\&. The public class \f3java\&.security\&.BasicPermission\fR is marked with the \f3@serial exclude\fR tag\&. The package-private class \f3java\&.util\&.PropertyPermissionCollection\fR is marked with the \f3@serial include\fR tag\&. The \f3@serial\fR tag at the class level overrides the \f3@serial\fR tag at the package level\&. - -.RE .TP @serialData \fIdata-description\fR Introduced in JDK 1\&.2 @@ -1387,7 +1384,7 @@ \f3public static final String SCRIPT_START = "