From 37d5361548bf912e69c734d56edba35d9a32945a Mon Sep 17 00:00:00 2001 From: WouterJ Date: Wed, 23 Jul 2014 16:53:09 +0200 Subject: [PATCH] Documented info method --- components/config/definition.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/components/config/definition.rst b/components/config/definition.rst index 772f51ceb9f..5b8909bf637 100644 --- a/components/config/definition.rst +++ b/components/config/definition.rst @@ -281,6 +281,19 @@ has a certain value: ->end() ; +Documenting the Option +---------------------- + +All options can be documented using the +:method:`Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::info` +method. + +The info will be printed as a comment when dumping the configuration tree. + +.. versionadded:: 2.6 + Since Symfony 2.6, the info will also be added to the exception message + when an invalid type is given. + Optional Sections -----------------