You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by "Jesse Wilson (JIRA)" <ji...@apache.org> on 2009/05/02 02:21:30 UTC

[jira] Created: (HARMONY-6194) Javadocs for java.lang.*

Javadocs for java.lang.*
------------------------

                 Key: HARMONY-6194
                 URL: https://issues.apache.org/jira/browse/HARMONY-6194
             Project: Harmony
          Issue Type: Improvement
          Components: Classlib
         Environment: SVN Revision: 770773
            Reporter: Jesse Wilson
            Priority: Minor
             Fix For: 5.0M10
         Attachments: Lang_Javadoc_from_Android.patch

Improvements to the luni/lang Javadocs from Android.
http://developer.android.com/reference/java/lang/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Closed: (HARMONY-6194) Javadocs for java.lang.*

Posted by "Jesse Wilson (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HARMONY-6194?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jesse Wilson closed HARMONY-6194.
---------------------------------


Looks good to me.

The motivation for the change from the good name 'value' to a bad name 'i' is for consistency with the RI. Parameter names are kinda-sorta part of the public API, since they show up in Javadocs and in IDE completions, so there's merits to consistency with the RI.

In this specific case, 'value' is a good name and I'm happy with that.


> Javadocs for java.lang.*
> ------------------------
>
>                 Key: HARMONY-6194
>                 URL: https://issues.apache.org/jira/browse/HARMONY-6194
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Classlib
>         Environment: SVN Revision: 770773
>            Reporter: Jesse Wilson
>            Assignee: Tim Ellison
>            Priority: Minor
>             Fix For: 5.0M10
>
>         Attachments: Lang_Javadoc_from_Android.patch
>
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> Improvements to the luni/lang Javadocs from Android.
> http://developer.android.com/reference/java/lang/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (HARMONY-6194) Javadocs for java.lang.*

Posted by "Tim Ellison (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HARMONY-6194?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12705429#action_12705429 ] 

Tim Ellison commented on HARMONY-6194:
--------------------------------------

> The motivation for the change...

The beef was that the rename did not match the formal parameter used in the method, so renaming the javadoc /and/ parameter name would have been ok, but renaming the javadoc description and not the formal parameter causes a javadoc warning that 'i' does not exist.


> Javadocs for java.lang.*
> ------------------------
>
>                 Key: HARMONY-6194
>                 URL: https://issues.apache.org/jira/browse/HARMONY-6194
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Classlib
>         Environment: SVN Revision: 770773
>            Reporter: Jesse Wilson
>            Assignee: Tim Ellison
>            Priority: Minor
>             Fix For: 5.0M10
>
>         Attachments: Lang_Javadoc_from_Android.patch
>
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> Improvements to the luni/lang Javadocs from Android.
> http://developer.android.com/reference/java/lang/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Resolved: (HARMONY-6194) Javadocs for java.lang.*

Posted by "Tim Ellison (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HARMONY-6194?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tim Ellison resolved HARMONY-6194.
----------------------------------

    Resolution: Fixed

Thanks Jesse.

A very minor tweak in Integer#toString(int)

-     * @param value
-     *            an int to get the representation of
-     * @return String the representation of the argument
+     * @param i
+     *            the integer to convert.
+     * @return the decimal string representation of {@code i}.

The parameter name really is 'value', so I changed the patch reference from 'i' back to 'value'.  Given the large number of excellent improvements I feel bad about even mentioning it!

Patch applied to LUNI module at repo revision r770909.

Please check it was applied as you expected.


> Javadocs for java.lang.*
> ------------------------
>
>                 Key: HARMONY-6194
>                 URL: https://issues.apache.org/jira/browse/HARMONY-6194
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Classlib
>         Environment: SVN Revision: 770773
>            Reporter: Jesse Wilson
>            Assignee: Tim Ellison
>            Priority: Minor
>             Fix For: 5.0M10
>
>         Attachments: Lang_Javadoc_from_Android.patch
>
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> Improvements to the luni/lang Javadocs from Android.
> http://developer.android.com/reference/java/lang/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (HARMONY-6194) Javadocs for java.lang.*

Posted by "Jesse Wilson (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HARMONY-6194?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jesse Wilson updated HARMONY-6194:
----------------------------------

    Attachment: Lang_Javadoc_from_Android.patch

> Javadocs for java.lang.*
> ------------------------
>
>                 Key: HARMONY-6194
>                 URL: https://issues.apache.org/jira/browse/HARMONY-6194
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Classlib
>         Environment: SVN Revision: 770773
>            Reporter: Jesse Wilson
>            Priority: Minor
>             Fix For: 5.0M10
>
>         Attachments: Lang_Javadoc_from_Android.patch
>
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> Improvements to the luni/lang Javadocs from Android.
> http://developer.android.com/reference/java/lang/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Assigned: (HARMONY-6194) Javadocs for java.lang.*

Posted by "Tim Ellison (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HARMONY-6194?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tim Ellison reassigned HARMONY-6194:
------------------------------------

    Assignee: Tim Ellison

> Javadocs for java.lang.*
> ------------------------
>
>                 Key: HARMONY-6194
>                 URL: https://issues.apache.org/jira/browse/HARMONY-6194
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Classlib
>         Environment: SVN Revision: 770773
>            Reporter: Jesse Wilson
>            Assignee: Tim Ellison
>            Priority: Minor
>             Fix For: 5.0M10
>
>         Attachments: Lang_Javadoc_from_Android.patch
>
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> Improvements to the luni/lang Javadocs from Android.
> http://developer.android.com/reference/java/lang/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.