Merge pull request #2706 from WouterJ/issue_2477

weaverryan · weaverryan · commit 34fac254fa81 · 2013-06-30T14:04:17.000-07:00
Added docs for enum nodes
diff --git a/components/config/definition.rst b/components/config/definition.rst
@@ -106,6 +106,25 @@ node definition. Node type are available for:
 and are created with ``node($name, $type)`` or their associated shortcut
 ``xxxxNode($name)`` method.
 
+Enum nodes
+~~~~~~~~~~
+
+.. versionadded:: 2.1
+    The enum node is new in 2.1
+
+Enum nodes provide a constraint to match the given input against a set of
+values::
+
+    $rootNode
+        ->children()
+            ->enumNode('gender')
+                ->values(array('male', 'female'))
+            ->end()
+        ->end()
+    ;
+
+This will restrict the ``gender`` option to be either ``male`` or ``female``.
+
 Array nodes
 ~~~~~~~~~~~
 
