commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Oliver Heger (JIRA)" <j...@apache.org>
Subject [jira] Resolved: (CONFIGURATION-231) documentation: Get string returns null?
Date Wed, 20 Dec 2006 21:37:23 GMT
     [ http://issues.apache.org/jira/browse/CONFIGURATION-231?page=all ]

Oliver Heger resolved CONFIGURATION-231.
----------------------------------------

    Fix Version/s: Nightly Builds
       Resolution: Fixed

I have added some @see tags pointing to setThrowExceptionOnMissing() to the relevant get methods
and put an additional node to the class comment of AbstractConfiguration. Together with the
class comment of the Configuration interface the documentation about missing properties should
now be quite complete.

The JavaDoc to getStringArray() was improved, too.

I am marking this ticket as fixed. Feel free to reopen if you want to suggest further documentation
improvements in this area.

> documentation: Get string returns null?
> ---------------------------------------
>
>                 Key: CONFIGURATION-231
>                 URL: http://issues.apache.org/jira/browse/CONFIGURATION-231
>             Project: Commons Configuration
>          Issue Type: Improvement
>            Reporter: Thomas Wabner
>         Assigned To: Oliver Heger
>             Fix For: Nightly Builds
>
>
> Some open documentation issues:
> In the current documentation (1.3) there is for the Configuration#getString() method
not documented, of this method returns a null string, if no value for the key was found.
> It should also be documented, if the given key can be null or not. For example if I can
give a null key, null will be returned would be enough in this case.
> Configuration#getStringArray point not to a documentation (or gives no hint), that there
is a way to configure the seperator for keys. Would be nice to have this in this place with
a link to the seperator stuff.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://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@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message