Skip to content

Commit

Permalink
feature #4047 Documented info method (WouterJ)
Browse files Browse the repository at this point in the history
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #4047).

Discussion
----------

Documented info method

| Q   | A
| --- | ---
| Doc fix? | no
| New docs? | yes (symfony/symfony#11453)
| Applies to | 2.6+
| Fixed tickets | -

Commits
-------

37d5361 Documented info method
  • Loading branch information
weaverryan committed Oct 1, 2014
2 parents c332063 + e211f56 commit e44c791
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions components/config/definition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,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
-----------------

Expand Down

0 comments on commit e44c791

Please sign in to comment.