RFR: 8029489: StringJoiner spec for setEmptyValue() and length() is malformatted

[Joseph Darcy]

Hi Stuart,

Looks good; thanks,

-Joe

On 12/3/2013 5:40 PM, Stuart Marks wrote:
> Hi all,
>
> Please review the following small javadoc change. The StringJoiner doc 
> for a couple methods uses "i.e." in the first sentence, which screws 
> up the javadoc logic that pulls the first sentence into the Method 
> Summary. This is an editorial change to fix this up; there is no 
> actual specification change.
>
> Thanks!
>
> s'marks
>
> # HG changeset patch
> # User smarks
> # Date 1386121046 28800
> # Node ID 0bc91b9f6afd9b4dceea31ecd1036e367b365690
> # Parent  75165f6c1c505ff43f7fd235a95b2e7955413b78
> 8029489: StringJoiner spec for setEmptyValue() and length() is 
> malformatted
> Reviewed-by: XXX
>
> diff -r 75165f6c1c50 -r 0bc91b9f6afd 
> src/share/classes/java/util/StringJoiner.java
> --- a/src/share/classes/java/util/StringJoiner.java    Tue Dec 03 
> 17:25:28 2013 -0800
> +++ b/src/share/classes/java/util/StringJoiner.java    Tue Dec 03 
> 17:37:26 2013 -0800
> @@ -131,7 +131,7 @@
>      /**
>       * Sets the sequence of characters to be used when determining 
> the string
>       * representation of this {@code StringJoiner} and no elements 
> have been
> -     * added yet, i.e. when it is empty.  A copy of the {@code 
> emptyValue}
> +     * added yet, that is, when it is empty.  A copy of the {@code 
> emptyValue}
>       * parameter is made for this purpose. Note that once an add 
> method has been
>       * called, the {@code StringJoiner} is no longer considered 
> empty, even if
>       * the element(s) added correspond to the empty {@code String}.
> @@ -228,8 +228,8 @@
>      }
>
>      /**
> -     * The length of the {@code StringJoiner} value, i.e. the length of
> -     * {@code String} representation of the {@code StringJoiner}. 
> Note that if
> +     * Returns the length of the {@code String} representation
> +     * of this {@code StringJoiner}. Note that if
>       * no add methods have been called, then the length of the {@code 
> String}
>       * representation (either {@code prefix + suffix} or {@code 
> emptyValue})
>       * will be returned. The value should be equivalent to