Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 37d5361

Browse filesBrowse files
committed
Documented info method
1 parent 47fe03a commit 37d5361
Copy full SHA for 37d5361

File tree

Expand file treeCollapse file tree

1 file changed

+13
-0
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+13
-0
lines changed

‎components/config/definition.rst

Copy file name to clipboardExpand all lines: components/config/definition.rst
+13Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,19 @@ has a certain value:
281281
->end()
282282
;
283283
284+
Documenting the Option
285+
----------------------
286+
287+
All options can be documented using the
288+
:method:`Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::info`
289+
method.
290+
291+
The info will be printed as a comment when dumping the configuration tree.
292+
293+
.. versionadded:: 2.6
294+
Since Symfony 2.6, the info will also be added to the exception message
295+
when an invalid type is given.
296+
284297
Optional Sections
285298
-----------------
286299

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.