[jbosstools-issues] [JBoss JIRA] Commented: (JBIDE-2685) API needs spell/grammar check

[Denis Maliarevich (JIRA)]

    [ https://jira.jboss.org/jira/browse/JBIDE-2685?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12459400#action_12459400 ] 

Denis Maliarevich commented on JBIDE-2685:
------------------------------------------

Specified mistakes were corrected.
I didn't find usefull spell/grammar checker for eclipse also. Automated tool won't fing all such mistakes, because, for example, "isChildren" could be correct in one case  and would be  wrong in the other (depends on the content). So we cannot avoid manual check.

> API needs spell/grammar check
> -----------------------------
>
>                 Key: JBIDE-2685
>                 URL: https://jira.jboss.org/jira/browse/JBIDE-2685
>             Project: Tools (JBoss Tools)
>          Issue Type: Bug
>          Components: Visual Page Editor Templates
>    Affects Versions: 3.0.0.alpha
>            Reporter: Marshall Culpepper
>            Assignee: Denis Maliarevich
>            Priority: Minor
>             Fix For: 3.1.0
>
>
> A lot of API methods/fields/parameters in VPE are mis-spelled or use really funky grammar.. some examples:
> in org.jboss.tools.vpe.editor.template.VpeTemplate:
> - method getNodeForUptate
> - method resize with attribute "resizerConstrains"
> - method isRecreateAtAttrChange : should probably be something like "needsRecreateAtAttrChange" or just "recreateAtAttrChange"
> - method isChildren should be hasChildren
> - method getOutputAtributeNames
> - method isModify should be canModify
> - method getVisualNodeByBySourcePosition (too many "by"s)
> And other various errors I've run across:
> - class TextFormatingData should be TextFormattingData (same for getters/setters)
> On top of this, the javadocs are nearly impossible to read =( I'll end up submitting a patch to help out here as I'm sure this is just tough translation issues (as are all of these, but API seems more important to get right IMO)

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira