[jira] Commented: (CONFIGURATION-231) documentation: Get string returns null?

["Oliver Heger (JIRA)" <ji...@apache.org>]

    [ http://issues.apache.org/jira/browse/CONFIGURATION-231?page=comments#action_12442298 ] 
            
Oliver Heger commented on CONFIGURATION-231:
--------------------------------------------

You are right, the information you mention is not easily to find. WDYT, would @see tags in the javadoc be appropriate that point to related methods like setThrowExceptionOnMissing() or setListDelimiter()? Or where would be the best way to place this information?

> 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
>
> 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