[jboss-jira] [JBoss JIRA] Created: (JBCACHE-1135) Add javadocs to XmlHelper

[Galder Zamarreno (JIRA)]

Add javadocs to XmlHelper
-------------------------

                 Key: JBCACHE-1135
                 URL: http://jira.jboss.com/jira/browse/JBCACHE-1135
             Project: JBoss Cache
          Issue Type: Task
      Security Level: Public (Everyone can see)
    Affects Versions: 1.4.1.SP3
            Reporter: Galder Zamarreno
         Assigned To: Manik Surtani
            Priority: Optional
             Fix For: 2.0.0.CR4, 2.0.0.GA


XmlHelper methods don't have any Javadocs which means that unless you read through
the implementation, you can't know whether they can return null or not, or whether they
return empty strings...etc.

I think we should write them so that the rest of the code does not over/under checks the values
retrieved from XML.

Example: String readStringContents()
Looking at the implementation, I can see null will never be returned from the method call. I have to
check for either empty or non empty Strings.

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