Add documentation for 'useDefaultsIfNotSet()' configuration method

craig · weaverryan · commit 0d3fe3334a72 · 2013-02-24T16:46:27.000-08:00
diff --git a/components/config/definition.rst b/components/config/definition.rst
@@ -151,10 +151,12 @@ Array node options
 Before defining the children of an array node, you can provide options like:
 
 ``useAttributeAsKey()``
-    Provide the name of a child node, whose value should be used as the key in the resulting array
+    Provide the name of a child node, whose value should be used as the key in the resulting array.
 ``requiresAtLeastOneElement()``
     There should be at least one element in the array (works only when ``isRequired()`` is also
     called).
+``addDefaultsIfNotSet()``
+    If any child nodes have default values, use them if explicit values haven't been provided.
 
 An example of this::
 
@@ -224,6 +226,16 @@ has a certain value:
                     ->end()
                 ->end()
             ->end()
+            ->arrayNode('settings')
+                ->useDefaultsIfNotSet()
+                ->children()
+                    ->scalarNode('name')
+                        ->isRequired()
+                        ->cannotBeEmpty()
+                        ->defaultValue('value')
+                    ->end()
+                ->end()
+            ->end()
         ->end()
     ;
 
