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::
183
183
184
184
See :ref: `components-property-info-type ` for info about the ``Type `` class.
185
185
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
+
186
206
.. _property-info-description :
187
207
188
208
Description Information
@@ -413,6 +433,12 @@ library is present::
413
433
// Description information.
414
434
$phpDocExtractor->getShortDescription($class, $property);
415
435
$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.
416
442
417
443
PhpStanExtractor
418
444
~~~~~~~~~~~~~~~~
You can’t perform that action at this time.
0 commit comments