You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by te...@apache.org on 2008/02/13 14:48:32 UTC
svn commit: r627408 - in /harmony/enhanced/classlib/trunk/modules:
luni/src/main/java/java/io/ luni/src/main/java/java/lang/
luni/src/main/java/java/util/ nio_char/src/main/java/java/nio/charset/
regex/src/main/java/java/util/regex/ text/src/main/java/...
Author: tellison
Date: Wed Feb 13 05:48:29 2008
New Revision: 627408
URL: http://svn.apache.org/viewvc?rev=627408&view=rev
Log:
Replace actual Unicode literal sequences in javadoc comments with depictions of the sequence,
i.e. writing \u0000 in a javadoc comment results in a nul char actually in the comment,
but writing \u0000 results in "\u0000" being produced.
Modified:
harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/BufferedReader.java
harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/StreamTokenizer.java
harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractStringBuilder.java
harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java
harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/String.java
harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/StringBuffer.java
harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/FormattableFlags.java
harmony/enhanced/classlib/trunk/modules/nio_char/src/main/java/java/nio/charset/CharsetDecoder.java
harmony/enhanced/classlib/trunk/modules/regex/src/main/java/java/util/regex/Pattern.java
harmony/enhanced/classlib/trunk/modules/text/src/main/java/java/text/CollationElementIterator.java
Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/BufferedReader.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/BufferedReader.java?rev=627408&r1=627407&r2=627408&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/BufferedReader.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/BufferedReader.java Wed Feb 13 05:48:29 2008
@@ -302,7 +302,7 @@
* <code>'\r\n'</code> or end of stream. The <code>String</code> does not
* include the newline sequence.
* In EBCDIC systems, a new line can also be represented by the
- * <code>'\u0085'</code> (NEL) character.
+ * <code>'\u0085'</code> (NEL) character.
*
* @return the contents of the line or null if no characters were read
* before end of stream.
Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/StreamTokenizer.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/StreamTokenizer.java?rev=627408&r1=627407&r2=627408&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/StreamTokenizer.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/StreamTokenizer.java Wed Feb 13 05:48:29 2008
@@ -120,7 +120,7 @@
* specification.
*/
private StreamTokenizer() {
- /**
+ /*
* Initialize the default state per specification. All byte values 'A'
* through 'Z', 'a' through 'z', and '\u00A0' through '\u00FF' are
* considered to be alphabetic.
@@ -173,10 +173,10 @@
* Construct a new StreamTokenizer on the Reader <code>r</code>.
* Initialize the default state per specification.
* <UL>
- * <LI>All byte values 'A' through 'Z', 'a' through 'z', and '\u00A0'
- * through '\u00FF' are considered to be alphabetic.</LI>
- * <LI>All byte values '\u0000' through '\u0020' are considered to be white
- * space. '/' is a comment character.</LI>
+ * <LI>All byte values 'A' through 'Z', 'a' through 'z', and '\u00A0'
+ * through '\u00FF' are considered to be alphabetic.</LI>
+ * <LI>All byte values '\u0000' through '\u0020' are considered to
+ * be white space. '/' is a comment character.</LI>
* <LI>Single quote '\'' and double quote '"' are string quote characters.</LI>
* <LI>Numbers are parsed.</LI>
* <LI>Ends of lines are considered to be white space rather than separate
Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractStringBuilder.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractStringBuilder.java?rev=627408&r1=627407&r2=627408&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractStringBuilder.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractStringBuilder.java Wed Feb 13 05:48:29 2008
@@ -497,7 +497,7 @@
/**
* Sets the current length to a new value. If the new length is larger than
* the current length, then the new characters at the end of this object
- * will contain the <code>char</code> value of <code>\u0000</code>.
+ * will contain the <code>char</code> value of <code>\u0000</code>.
*
* @param length
* the new length of this StringBuffer
Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java?rev=627408&r1=627407&r2=627408&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java Wed Feb 13 05:48:29 2008
@@ -370,7 +370,7 @@
/**
* <p>
* Minimum value of a high surrogate or leading surrogate unit in UTF-16
- * encoding - <code>'\uD800'</code>.
+ * encoding - <code>'\uD800'</code>.
* </p>
*
* @since 1.5
@@ -380,7 +380,7 @@
/**
* <p>
* Maximum value of a high surrogate or leading surrogate unit in UTF-16
- * encoding - <code>'\uDBFF'</code>.
+ * encoding - <code>'\uDBFF'</code>.
* </p>
*
* @since 1.5
@@ -390,7 +390,7 @@
/**
* <p>
* Minimum value of a low surrogate or trailing surrogate unit in UTF-16
- * encoding - <code>'\uDC00'</code>.
+ * encoding - <code>'\uDC00'</code>.
* </p>
*
* @since 1.5
@@ -399,7 +399,7 @@
/**
* Maximum value of a low surrogate or trailing surrogate unit in UTF-16
- * encoding - <code>'\uDFFF'</code>.
+ * encoding - <code>'\uDFFF'</code>.
* </p>
*
* @since 1.5
@@ -408,7 +408,7 @@
/**
* <p>
- * Minimum value of a surrogate unit in UTF-16 encoding - <code>'\uD800'</code>.
+ * Minimum value of a surrogate unit in UTF-16 encoding - <code>'\uD800'</code>.
* </p>
*
* @since 1.5
@@ -417,7 +417,7 @@
/**
* <p>
- * Maximum value of a surrogate unit in UTF-16 encoding - <code>'\uDFFF'</code>.
+ * Maximum value of a surrogate unit in UTF-16 encoding - <code>'\uDFFF'</code>.
* </p>
*
* @since 1.5
Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/String.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/String.java?rev=627408&r1=627407&r2=627408&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/String.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/String.java Wed Feb 13 05:48:29 2008
@@ -1550,7 +1550,7 @@
* Return the index of the specified character into the upperValues table.
* The upperValues table contains three entries at each position. These
* three characters are the upper case conversion. If only two characters
- * are used, the third character in the table is \u0000.
+ * are used, the third character in the table is \u0000.
*
* @param ch
* the char being converted to upper case
@@ -1673,7 +1673,7 @@
* Copies this String removing white space characters from the beginning and
* end of the string.
*
- * @return a new String with characters <code><= \\u0020</code> removed
+ * @return a new String with characters <code><= \u0020</code> removed
* from the beginning and the end
*/
public String trim() {
Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/StringBuffer.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/StringBuffer.java?rev=627408&r1=627407&r2=627408&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/StringBuffer.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/StringBuffer.java Wed Feb 13 05:48:29 2008
@@ -836,7 +836,7 @@
* Sets the length of this StringBuffer to the specified length. If there
* are more than length characters in this StringBuffer, the characters at
* end are lost. If there are less than length characters in the
- * StringBuffer, the additional characters are set to <code>\\u0000</code>.
+ * StringBuffer, the additional characters are set to <code>\u0000</code>.
*
* @param length
* the new length of this StringBuffer
Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/FormattableFlags.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/FormattableFlags.java?rev=627408&r1=627407&r2=627408&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/FormattableFlags.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/FormattableFlags.java Wed Feb 13 05:48:29 2008
@@ -29,11 +29,11 @@
/**
* Denotes the output to be left-justified. In order to fill the minimum
- * width requirement, spaces('\u0020') will be appended at the end of the
+ * width requirement, spaces('\u0020') will be appended at the end of the
* specified output element. If no such flag is set, the output is
* right-justified.
*
- * The flag corresponds to '-' ('\u002d') in the format specifier.
+ * The flag corresponds to '-' ('\u002d') in the format specifier.
*/
public static final int LEFT_JUSTIFY = 1;
@@ -42,7 +42,7 @@
* parameter of Formatter.formatTo() requires. The output has the same
* effect as String.toUpperCase(java.util.Locale).
*
- * This flag corresponds to '^' ('\u005e') in the format specifier.
+ * This flag corresponds to '^' ('\u005e') in the format specifier.
*/
public static final int UPPERCASE = 2;
@@ -50,7 +50,7 @@
* Denotes the output to be formatted in an alternate form. The definition
* of the alternate form is given out by Formattable.
*
- * This flag corresponds to '#' ('\u0023') in the format specifier.
+ * This flag corresponds to '#' ('\u0023') in the format specifier.
*/
public static final int ALTERNATE = 4;
}
Modified: harmony/enhanced/classlib/trunk/modules/nio_char/src/main/java/java/nio/charset/CharsetDecoder.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/nio_char/src/main/java/java/nio/charset/CharsetDecoder.java?rev=627408&r1=627407&r2=627408&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/nio_char/src/main/java/java/nio/charset/CharsetDecoder.java (original)
+++ harmony/enhanced/classlib/trunk/modules/nio_char/src/main/java/java/nio/charset/CharsetDecoder.java Wed Feb 13 05:48:29 2008
@@ -65,7 +65,7 @@
* The two errors can be handled in three ways, the default one is to report the
* error to the invoker by a {@link CoderResult CoderResult} instance, and the
* alternatives are to ignore it or to replace the erroneous input with the
- * replacement string. The replacement string is "\uFFFD" by default and can be
+ * replacement string. The replacement string is "\uFFFD" by default and can be
* changed by invoking {@link #replaceWith(String) replaceWith} method. The
* invoker of this decoder can choose one way by specifying a
* {@link CodingErrorAction CodingErrorAction} instance for each error type via
Modified: harmony/enhanced/classlib/trunk/modules/regex/src/main/java/java/util/regex/Pattern.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/regex/src/main/java/java/util/regex/Pattern.java?rev=627408&r1=627407&r2=627408&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/regex/src/main/java/java/util/regex/Pattern.java (original)
+++ harmony/enhanced/classlib/trunk/modules/regex/src/main/java/java/util/regex/Pattern.java Wed Feb 13 05:48:29 2008
@@ -215,59 +215,60 @@
}
/**
- * Return a compiled pattern corresponding to the input regular expression
- * string.
- *
- * The input <code>flags</code> is a mask of the following flags:
- * <dl>
- * <dt><code>UNIX_LINES</code> (0x0001)
- * <dd>Enables UNIX lines mode where only \n is recognized as a line
- * terminator. The default setting of this flag is <em>off</em> indicating
- * that all of the following character sequences are recognized as line
- * terminators: \n, \r, \r\n, NEL (\u0085), \u2028 and \u2029.
- * <dt><code>CASE_INSENSITIVE</code> (0x0002)
- * <dd>Directs matching to be done in a way that ignores differences in
- * case. If input character sequences are encoded in character sets other
- * than ASCII, then the UNICODE_CASE must also be set to enable Unicode case
- * detection.
- * <dt><code>UNICODE_CASE</code> (0x0040)
- * <dd>Enables Unicode case folding if used in conjunction with the
- * <code>CASE_INSENSITIVE</code> flag. If <code>CASE_INSENSITIVE</code>
- * is not set, then this flag has no effect.
- * <dt><code>COMMENTS</code> (0x0004)
- * <dd>Directs the pattern compiler to ignore whitespace and comments in
- * the pattern. Whitespace consists of sequences including only these
- * characters: SP (\u0020), HT (\t or \u0009), LF (\n or ), VT (\u000b), FF
- * (\f or \u000c), and CR (\r or ). A comment is any sequence of characters
- * beginning with the "#" (\u0023) character and ending in a LF character.
- * <dt><code>MULTILINE</code> (0x0008)
- * <dd>Turns on multiple line mode for matching of character sequences. By
- * default, this mode is off so that the character "^" (\u005e) matches the
- * beginning of the entire input sequence and the character "$" (\u0024)
- * matches the end of the input character sequence. In multiple line mode,
- * the character "^" matches any character in the input sequence which
- * immediately follows a line terminator and the character "$" matches any
- * character in the input sequence which immediately precedes a line
- * terminator.
- * <dt><code>DOTALL</code> (0x0020)
- * <dd>Enables the DOT (".") character in regular expressions to match line
- * terminators. By default, line terminators are not matched by DOT.
- * <dt><code>CANON_EQ</code> (0x0080)
- * <dd>Enables matching of character sequences which are canonically
- * equivalent according to the Unicode standard. Canonical equivalence is
- * described here: http://www.unicode.org/reports/tr15/. By default,
- * canonical equivalence is not detected while matching.
- * </dl>
- *
- * @param regex
- * A regular expression string.
- * @param flags
- * A set of flags to control the compilation of the pattern.
- * @return A compiled pattern
- * @throws PatternSyntaxException
- * If the input regular expression does not match the required
- * grammar.
- */
+ * Return a compiled pattern corresponding to the input regular expression
+ * string.
+ *
+ * The input <code>flags</code> is a mask of the following flags:
+ * <dl>
+ * <dt><code>UNIX_LINES</code> (0x0001)
+ * <dd>Enables UNIX lines mode where only \n is recognized as a line
+ * terminator. The default setting of this flag is <em>off</em> indicating
+ * that all of the following character sequences are recognized as line
+ * terminators: \n, \r, \r\n, NEL (\u0085), \u2028 and \u2029.
+ * <dt><code>CASE_INSENSITIVE</code> (0x0002)
+ * <dd>Directs matching to be done in a way that ignores differences in
+ * case. If input character sequences are encoded in character sets other
+ * than ASCII, then the UNICODE_CASE must also be set to enable Unicode case
+ * detection.
+ * <dt><code>UNICODE_CASE</code> (0x0040)
+ * <dd>Enables Unicode case folding if used in conjunction with the
+ * <code>CASE_INSENSITIVE</code> flag. If <code>CASE_INSENSITIVE</code>
+ * is not set, then this flag has no effect.
+ * <dt><code>COMMENTS</code> (0x0004)
+ * <dd>Directs the pattern compiler to ignore whitespace and comments in
+ * the pattern. Whitespace consists of sequences including only these
+ * characters: SP (\u0020), HT (\t or \u0009), LF (\n or ), VT
+ * (\u000b), FF (\f or \u000c), and CR (\r or ). A comment is any
+ * sequence of characters beginning with the "#" (\u0023) character and
+ * ending in a LF character.
+ * <dt><code>MULTILINE</code> (0x0008)
+ * <dd>Turns on multiple line mode for matching of character sequences. By
+ * default, this mode is off so that the character "^" (\u005e) matches
+ * the beginning of the entire input sequence and the character "$"
+ * (\u0024) matches the end of the input character sequence. In multiple
+ * line mode, the character "^" matches any character in the input sequence
+ * which immediately follows a line terminator and the character "$" matches
+ * any character in the input sequence which immediately precedes a line
+ * terminator.
+ * <dt><code>DOTALL</code> (0x0020)
+ * <dd>Enables the DOT (".") character in regular expressions to match line
+ * terminators. By default, line terminators are not matched by DOT.
+ * <dt><code>CANON_EQ</code> (0x0080)
+ * <dd>Enables matching of character sequences which are canonically
+ * equivalent according to the Unicode standard. Canonical equivalence is
+ * described here: http://www.unicode.org/reports/tr15/. By default,
+ * canonical equivalence is not detected while matching.
+ * </dl>
+ *
+ * @param regex
+ * A regular expression string.
+ * @param flags
+ * A set of flags to control the compilation of the pattern.
+ * @return A compiled pattern
+ * @throws PatternSyntaxException
+ * If the input regular expression does not match the required
+ * grammar.
+ */
public static Pattern compile(String regex, int flags)
throws PatternSyntaxException {
Modified: harmony/enhanced/classlib/trunk/modules/text/src/main/java/java/text/CollationElementIterator.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/text/src/main/java/java/text/CollationElementIterator.java?rev=627408&r1=627407&r2=627408&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/text/src/main/java/java/text/CollationElementIterator.java (original)
+++ harmony/enhanced/classlib/trunk/modules/text/src/main/java/java/text/CollationElementIterator.java Wed Feb 13 05:48:29 2008
@@ -55,13 +55,13 @@
*
* <p>
* <code>
- * Since the character '\u0086' is a composed character of 'a' and 'e', the iterator
- * returns two collation elements for the single character '\u0086'
+ * Since the character '\u0086' is a composed character of 'a' and 'e', the iterator
+ * returns two collation elements for the single character '\u0086'
* </code>
* </p>
* <p>
* <code>
- * "\u0086b" -> the first
+ * "\u0086b" -> the first
* collation element is collation_element('a'), the second collation element is
* collation_element('e'), and the third collation element is
* collation_element('b').
[classlib] Unicode sequences in JavaDoc comments
Posted by Tim Ellison <t....@gmail.com>.
Just a heads-up that when you write Unicode sequences in JavaDoc
comments they will be replaced by the actual Unicode character in the
processed output.
If you want to depict the literal sequence you should use \uXXXX
format (where '\' gets replaced by '\').
Makes things much more readable <g>.
Regards,
Tim
tellison@apache.org wrote:
> Author: tellison
> Date: Wed Feb 13 05:48:29 2008
> New Revision: 627408
>
> URL: http://svn.apache.org/viewvc?rev=627408&view=rev
> Log:
> Replace actual Unicode literal sequences in javadoc comments with depictions of the sequence,
> i.e. writing \u0000 in a javadoc comment results in a nul char actually in the comment,
> but writing \u0000 results in "\u0000" being produced.
>
> Modified:
> harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/BufferedReader.java
> harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/StreamTokenizer.java
> harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractStringBuilder.java
> harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java
> harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/String.java
> harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/StringBuffer.java
> harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/FormattableFlags.java
> harmony/enhanced/classlib/trunk/modules/nio_char/src/main/java/java/nio/charset/CharsetDecoder.java
> harmony/enhanced/classlib/trunk/modules/regex/src/main/java/java/util/regex/Pattern.java
> harmony/enhanced/classlib/trunk/modules/text/src/main/java/java/text/CollationElementIterator.java