File tree Expand file tree Collapse file tree 1 file changed +26
-0
lines changed Expand file tree Collapse file tree 1 file changed +26
-0
lines changed Original file line number Diff line number Diff line change @@ -183,6 +183,26 @@ for a property::
183183
184184See :ref: `components-property-info-type ` for info about the ``Type `` class.
185185
186+ Documentation Block
187+ ~~~~~~~~~~~~~~~~~~~
188+
189+ Extractors that implement :class: `Symfony\\ Component\\ PropertyInfo\\ PropertyDocBlockExtractorInterface `
190+ can provide the full documentation block for a property as a string::
191+
192+ $docBlock = $propertyInfo->getDocBlock($class, $property);
193+ /*
194+ Example Result
195+ --------------
196+ string(79):
197+ This is the subsequent paragraph in the DocComment.
198+ It can span multiple lines.
199+ */
200+
201+ .. versionadded :: 7.1
202+
203+ The :class: `Symfony\\ Component\\ PropertyInfo\\ PropertyDocBlockExtractorInterface` `
204+ interface was introduced in Symfony 7.1.
205+
186206.. _property-info-description :
187207
188208Description Information
@@ -413,6 +433,12 @@ library is present::
413433 // Description information.
414434 $phpDocExtractor->getShortDescription($class, $property);
415435 $phpDocExtractor->getLongDescription($class, $property);
436+ $phpDocExtractor->getDocBlock($class, $property);
437+
438+ .. versionadded :: 7.1
439+
440+ The :method: `Symfony\\ Component\\ PropertyInfo\\ Extractor\\ PhpDocExtractor::getDocBlock` `
441+ method was introduced in Symfony 7.1.
416442
417443PhpStanExtractor
418444~~~~~~~~~~~~~~~~
You can’t perform that action at this time.
0 commit comments