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

[Marshall Culpepper (JIRA)]

     [ https://jira.jboss.org/jira/browse/JBIDE-2685?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Marshall Culpepper updated JBIDE-2685:
--------------------------------------

    Description: 
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)

  was:
A lot of API methods/fields/paramters 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)



Ironic.. i mis-spelled parameters ;)

> 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
>    Affects Versions: 3.0.0.alpha
>            Reporter: Marshall Culpepper
>
> 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