You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by "Nathan Beach (JIRA)" <ji...@apache.org> on 2007/09/13 05:38:32 UTC
[jira] Created: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Wicket Javadoc Standardization: org.apache.wicket.version.*
-----------------------------------------------------------
Key: WICKET-966
URL: https://issues.apache.org/jira/browse/WICKET-966
Project: Wicket
Issue Type: Improvement
Components: wicket
Affects Versions: 1.3.0-beta4
Environment: All.
Reporter: Nathan Beach
Priority: Minor
Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Nathan Beach (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12527115 ]
Nathan Beach commented on WICKET-966:
-------------------------------------
I was told American was the consensus, but I'll probably leave it alone for the most part. We could, however, do some percentage weighting per Class by @author, depending on which side of the Atlantic they're on... that would make it easier, for sure.
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Nathan Beach (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Nathan Beach updated WICKET-966:
--------------------------------
Attachment: WICKET-966.patch
SVN patch for the wicket.version.* packages attached.
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Assigned: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Igor Vaynberg (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Igor Vaynberg reassigned WICKET-966:
------------------------------------
Assignee: Igor Vaynberg
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Igor Vaynberg (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12527122 ]
Igor Vaynberg commented on WICKET-966:
--------------------------------------
it is very annoying to see color in some places and colour in others. we had this discussion already and agreed to use american spelling. i believe the disputed item at the time was behavior vs behaviour.
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Igor Vaynberg (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12527148 ]
Igor Vaynberg commented on WICKET-966:
--------------------------------------
hmm, i cant find it either :|
but i do remember we had it and a decision was made. if you dont feel comfortable with that then we have can have the discussion again.
> (incidently, I'd never put a @author tag in for any amount of JavaDoc changes)
i dont think any of us have ever done that...what are you referring to?
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Jean-Baptiste Quenot (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12527116 ]
Jean-Baptiste Quenot commented on WICKET-966:
---------------------------------------------
Looks good, but I wouldn't put a dot at the end of every line comment (//)
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Gwyn Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12527136 ]
Gwyn Evans commented on WICKET-966:
-----------------------------------
Out of interest, when, where & who was involved in this discussion?
I just did a search of my GMail archives (which admittedly, only got back to 2004) for "wicket spelling american" and that only threw up this thread...
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Gwyn Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12527154 ]
Gwyn Evans commented on WICKET-966:
-----------------------------------
I guess I am uncomfortable with it defined without a reference & would at least like to get an idea if an "either" option was acceptable, rather than a straightforward "or"?
As for the @author tag, that was in response to Nathan's suggestion of "weighting per Class by @author" & noting that it would give a skewed picture as it ignore any purely JavaDoc updates.
Not to suggest that anyone had done such here, although in other places, I've seen the tag used to indicate any/all modifiers of the file.
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Nathan Beach (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12527123 ]
Nathan Beach commented on WICKET-966:
-------------------------------------
Jean-Baptiste: I agree -- I think I'm actually going to completely leave any line comments alone. It gives the code some character from the original author, and there's no negative implications for the public API...
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Resolved: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Igor Vaynberg (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Igor Vaynberg resolved WICKET-966.
----------------------------------
Resolution: Fixed
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Gwyn Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12527065 ]
Gwyn Evans commented on WICKET-966:
-----------------------------------
> use Americanised :) spellings vs. British
Hmm... Not sure I can let that one go by - I'd suggest that either be accepted.
Doubt it'll make too much difference in practice, but still...
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Nathan Beach (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Nathan Beach updated WICKET-966:
--------------------------------
Attachment: wicketJavadocProject.txt
Rules for the Javadoc standardization project: 'These guidelines take obvious influence from the Sun Javadoc best practices guide. This round of work would not include any changes to the actual informational content of the Wicket Javadoc, but doing the following will set the Javadoc up with a consistent framework for some really nice programming guide documentation.'
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Priority: Minor
> Attachments: wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WICKET-966) Wicket Javadoc Standardization:
org.apache.wicket.version.*
Posted by "Nathan Beach (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12527155 ]
Nathan Beach commented on WICKET-966:
-------------------------------------
I was just joshin' about the author weighting anyway -- I think the standard is that JavaDoc contributors are never included in the @author tags.
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Issue Comment Edited: (WICKET-966) Wicket Javadoc
Standardization: org.apache.wicket.version.*
Posted by "Gwyn Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WICKET-966?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12527136 ]
gwynevans edited comment on WICKET-966 at 9/13/07 8:21 AM:
------------------------------------------------------------
Out of interest, when, where & who was involved in this discussion?
I just did a search of my GMail archives (which admittedly, only got back to 2004) for "wicket spelling american" and that only threw up this thread...
As I said, it's largely theoretical, as it's been the more obvious errors & typo's that I've corrected (incidently, I'd never put a @author tag in for any amount of JavaDoc changes), but I do get concerned about unqualifed references to "agreements" if they're likely to be codified in some form, as this one is.
was (Author: gwynevans):
Out of interest, when, where & who was involved in this discussion?
I just did a search of my GMail archives (which admittedly, only got back to 2004) for "wicket spelling american" and that only threw up this thread...
> Wicket Javadoc Standardization: org.apache.wicket.version.*
> -----------------------------------------------------------
>
> Key: WICKET-966
> URL: https://issues.apache.org/jira/browse/WICKET-966
> Project: Wicket
> Issue Type: Improvement
> Components: wicket
> Affects Versions: 1.3.0-beta4
> Environment: All.
> Reporter: Nathan Beach
> Assignee: Igor Vaynberg
> Priority: Minor
> Attachments: WICKET-966.patch, wicketJavadocProject.txt
>
>
> Javadoc standardization effort. This round: org.apache.wicket.version and org.apache.wicket.version.undo. See the attached wicketJavadocProject.txt for the rules being followed!
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.