You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commons-dev@ws.apache.org by "stefan stieglitz (JIRA)" <ji...@apache.org> on 2007/01/05 13:20:27 UTC
[jira] Created: (WSCOMMONS-145) Please please please write javadoc!
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
[jira] Commented: (WSCOMMONS-145) Please please please write
javadoc!
Posted by "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
[jira] Resolved: (WSCOMMONS-145) Please please please write
javadoc!
Posted by "Andreas Veithen (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WSCOMMONS-145?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Andreas Veithen resolved WSCOMMONS-145.
---------------------------------------
Resolution: Incomplete
I totally agree that Axiom is under-documented (I even voted for this issue...), but I don't think that things will improve by keeping this JIRA issue open indefinitely. The proof is that this issue has now been open for almost two years, but not much has been done. I think the better approach is to open JIRA issues that focus on particular parts of the Javadoc and that contain clear indication of what information the reporter wants to get (e.g. please specify expected behavior of method X in interface Y). Hopefully that way the situation will start to gradually improve. Actually, keeping this issue open might even be counterproductive because it discourages people from creating this kind of more focused issues.
> 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: Critical
>
> 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.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (WSCOMMONS-145) Please please please write javadoc!
Posted by "Deepal Jayasinghe (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WSCOMMONS-145?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Deepal Jayasinghe updated WSCOMMONS-145:
----------------------------------------
Priority: Critical (was: Blocker)
Making as critical for 1.2.3 release
> 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: Critical
>
> 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.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: commons-dev-help@ws.apache.org