[jira] Commented: (WSCOMMONS-145) Please please please write javadoc!

["Dennis Sosnoski (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/WSCOMMONS-145?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12462611 ] 

Dennis Sosnoski commented on WSCOMMONS-145:
-------------------------------------------

I agree completely - AXIOM is severely under-documented, which makes it very difficult to use. I've seen changes in behavior between AXIOM releases which have broken JiBX code for Axis2, but because the AXIOM documentation is so lacking I can't even say whether the changes in AXIOM behavior are a bug or a fix.

The fix is to document the way AXIOM is supposed to work, and add unit tests to make sure it actually does work that way (and will continue to do so in the future).

> Please please please write javadoc!
> -----------------------------------
>
>                 Key: WSCOMMONS-145
>                 URL: https://issues.apache.org/jira/browse/WSCOMMONS-145
>             Project: WS-Commons
>          Issue Type: Wish
>          Components: AXIOM
>         Environment: any version of AXIOM
>            Reporter: stefan stieglitz
>            Priority: Blocker
>
> No seriously, the lack of documentation renders this project almost unusable. I'm really sick and tired of guessing the function of the various classes and methods from their names.
> precise packages (possibly incomplete): 
>  org.apache.axiom.attachments
>  org.apache.axiom.attachments.utils
>  org.apache.axiom.om
>  org.apache.axiom.om.impl
>  org.apache.axiom.om.impl.dom.jaxp 
>  org.apache.axiom.om.impl.builder
>  org.apache.axiom.om.impl.exception
>  org.apache.axiom.om.impl.llom
>  org.apache.axiom.om.impl.llom.factory
>  org.apache.axiom.om.impl.llom.util
>  org.apache.axiom.om.impl.serialize
>  org.apache.axiom.om.impl.traverse
>  org.apache.axiom.om.impl.util
>  org.apache.axiom.om.util

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

        

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: commons-dev-help@ws.apache.org