1berry/openjdk
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

8021609: Fix doclint issues in java.nio.charset

Browse Source 
Reviewed-by: alanb
This commit is contained in:
Joe Darcy 2013-07-27 10:27:04 -07:00
parent 4fe69c432f
commit 7e692e2b86
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
jdk/src/share/classes/java/nio/charset/Charset-X-Coder.java.template
View File

@ -41,7 +41,7 @@ import java.util.Arrays;
* An engine that can transform a sequence of $itypesPhrase$ into a sequence of * An engine that can transform a sequence of $itypesPhrase$ into a sequence of
* $otypesPhrase$. * $otypesPhrase$.
* *
* <a name="steps"> * <a name="steps"></a>
* *
* <p> The input $itype$ sequence is provided in a $itype$ buffer or a series * <p> The input $itype$ sequence is provided in a $itype$ buffer or a series
* of such buffers. The output $otype$ sequence is written to a $otype$ buffer * of such buffers. The output $otype$ sequence is written to a $otype$ buffer
@ -76,22 +76,22 @@ import java.util.Arrays;
* examine this object and fill the input buffer, flush the output buffer, or * examine this object and fill the input buffer, flush the output buffer, or
* attempt to recover from $a$ $coding$ error, as appropriate, and try again. * attempt to recover from $a$ $coding$ error, as appropriate, and try again.
* *
* <a name="ce"> * <a name="ce"></a>
* *
* <p> There are two general types of $coding$ errors. If the input $itype$ * <p> There are two general types of $coding$ errors. If the input $itype$
* sequence is $notLegal$ then the input is considered <i>malformed</i>. If * sequence is $notLegal$ then the input is considered <i>malformed</i>. If
* the input $itype$ sequence is legal but cannot be mapped to a valid * the input $itype$ sequence is legal but cannot be mapped to a valid
* $outSequence$ then an <i>unmappable character</i> has been encountered. * $outSequence$ then an <i>unmappable character</i> has been encountered.
* *
* <a name="cae"> * <a name="cae"></a>
* *
* <p> How $a$ $coding$ error is handled depends upon the action requested for * <p> How $a$ $coding$ error is handled depends upon the action requested for
* that type of error, which is described by an instance of the {@link * that type of error, which is described by an instance of the {@link
* CodingErrorAction} class. The possible error actions are to {@link * CodingErrorAction} class. The possible error actions are to {@linkplain
* CodingErrorAction#IGNORE </code>ignore<code>} the erroneous input, {@link * CodingErrorAction#IGNORE ignore} the erroneous input, {@linkplain
* CodingErrorAction#REPORT </code>report<code>} the error to the invoker via * CodingErrorAction#REPORT report} the error to the invoker via
* the returned {@link CoderResult} object, or {@link CodingErrorAction#REPLACE * the returned {@link CoderResult} object, or {@linkplain CodingErrorAction#REPLACE
* </code>replace<code>} the erroneous input with the current value of the * replace} the erroneous input with the current value of the
* replacement $replTypeName$. The replacement * replacement $replTypeName$. The replacement
* *
#if[encoder] #if[encoder]
@ -106,7 +106,7 @@ import java.util.Arrays;
* replaceWith} method. * replaceWith} method.
* *
* <p> The default action for malformed-input and unmappable-character errors * <p> The default action for malformed-input and unmappable-character errors
* is to {@link CodingErrorAction#REPORT </code>report<code>} them. The * is to {@linkplain CodingErrorAction#REPORT report} them. The
* malformed-input error action may be changed via the {@link * malformed-input error action may be changed via the {@link
* #onMalformedInput(CodingErrorAction) onMalformedInput} method; the * #onMalformedInput(CodingErrorAction) onMalformedInput} method; the
* unmappable-character action may be changed via the {@link * unmappable-character action may be changed via the {@link
@ -177,7 +177,7 @@ public abstract class Charset$Coder$ {
* @param replacement * @param replacement
* The initial replacement; must not be <tt>null</tt>, must have * The initial replacement; must not be <tt>null</tt>, must have
* non-zero length, must not be longer than max$ItypesPerOtype$, * non-zero length, must not be longer than max$ItypesPerOtype$,
* and must be {@link #isLegalReplacement </code>legal<code>} * and must be {@linkplain #isLegalReplacement legal}
* *
* @throws IllegalArgumentException * @throws IllegalArgumentException
* If the preconditions on the parameters do not hold * If the preconditions on the parameters do not hold
@ -276,7 +276,7 @@ public abstract class Charset$Coder$ {
* The new replacement; must not be <tt>null</tt>, must have * The new replacement; must not be <tt>null</tt>, must have
* non-zero length, must not be longer than the value returned by * non-zero length, must not be longer than the value returned by
* the {@link #max$ItypesPerOtype$() max$ItypesPerOtype$} method, and * the {@link #max$ItypesPerOtype$() max$ItypesPerOtype$} method, and
* must be {@link #isLegalReplacement </code>legal<code>} * must be {@link #isLegalReplacement legal}
#end[encoder] #end[encoder]
* *
* @return This $coder$ * @return This $coder$
@ -495,24 +495,24 @@ public abstract class Charset$Coder$ {
* typically done by draining any $code$d $otype$s from the output * typically done by draining any $code$d $otype$s from the output
* buffer. </p></li> * buffer. </p></li>
* *
* <li><p> A {@link CoderResult#malformedForLength * <li><p> A {@linkplain CoderResult#malformedForLength
* </code>malformed-input<code>} result indicates that a malformed-input * malformed-input} result indicates that a malformed-input
* error has been detected. The malformed $itype$s begin at the input * error has been detected. The malformed $itype$s begin at the input
* buffer's (possibly incremented) position; the number of malformed * buffer's (possibly incremented) position; the number of malformed
* $itype$s may be determined by invoking the result object's {@link * $itype$s may be determined by invoking the result object's {@link
* CoderResult#length() length} method. This case applies only if the * CoderResult#length() length} method. This case applies only if the
* {@link #onMalformedInput </code>malformed action<code>} of this $coder$ * {@linkplain #onMalformedInput malformed action} of this $coder$
* is {@link CodingErrorAction#REPORT}; otherwise the malformed input * is {@link CodingErrorAction#REPORT}; otherwise the malformed input
* will be ignored or replaced, as requested. </p></li> * will be ignored or replaced, as requested. </p></li>
* *
* <li><p> An {@link CoderResult#unmappableForLength * <li><p> An {@linkplain CoderResult#unmappableForLength
* </code>unmappable-character<code>} result indicates that an * unmappable-character} result indicates that an
* unmappable-character error has been detected. The $itype$s that * unmappable-character error has been detected. The $itype$s that
* $code$ the unmappable character begin at the input buffer's (possibly * $code$ the unmappable character begin at the input buffer's (possibly
* incremented) position; the number of such $itype$s may be determined * incremented) position; the number of such $itype$s may be determined
* by invoking the result object's {@link CoderResult#length() length} * by invoking the result object's {@link CoderResult#length() length}
* method. This case applies only if the {@link #onUnmappableCharacter * method. This case applies only if the {@linkplain #onUnmappableCharacter
* </code>unmappable action<code>} of this $coder$ is {@link * unmappable action} of this $coder$ is {@link
* CodingErrorAction#REPORT}; otherwise the unmappable character will be * CodingErrorAction#REPORT}; otherwise the unmappable character will be
* ignored or replaced, as requested. </p></li> * ignored or replaced, as requested. </p></li>
* *