commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Oliver Heger (JIRA)" <>
Subject [jira] [Resolved] (CONFIGURATION-610) Improve Configuration Variable Documentation
Date Fri, 20 Nov 2015 20:40:11 GMT


Oliver Heger resolved CONFIGURATION-610.
       Resolution: Fixed
    Fix Version/s: 2.0

Some more details about variable substitution have been added to the corresponding chapter
in the user's guide. The Javadocs of the most important Configuration implementations now
reference this chapter.

> Improve Configuration Variable Documentation
> --------------------------------------------
>                 Key: CONFIGURATION-610
>                 URL:
>             Project: Commons Configuration
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 2.0-alpha1
>            Reporter: Dan Lamet
>             Fix For: 2.0
> The JavaDoc for [Class PropertiesConfiguration |]
lists a very handy feature of Configuration, which is variable substitution.  The behavior
can be seen in the example file on the JavaDoc (good).
> But it's not in the preceding list of features.  It would be nice to have a little writeup
describing the intended behavior:  What is supposed to happen if you have an undefined ref?
 What about nested refs?  What about circular refs? 
> And it was interesting to find that the substitution occurred during get time rather
than load (unexpected), and that if one calls the wrong get() method then the substitution
will not happen.  (Is that intended behavior?)  This should be called out in the description
as well as the individual method JavaDocs.

This message was sent by Atlassian JIRA

View raw message