[CONFIGURATION-569] Add API call to insert comments into save configuration

• Type: New Feature
• Status: Open
• Priority: Trivial
• Resolution: Unresolved
• Affects Version/s: 1.9
• Component/s: Format
• Assignee: Unassigned
• Reporter: Rodney Beede
• Created: 14/Feb/14 03:24
• Updated: 23/Feb/14 18:47

Description

An API to insert comments into saved to disk configurations would be nice. That would make it possible to write a default configuration file in code for first-time use.

The comments should be attached to particular config keys so that the comments appear right before the config key/value (or node in the tree) on disk.

The goal is to have some metadata to explain what values should/could be used for a particular configuration setting.