Skip to content

Commit 7ae9470

Browse files
committed
Improve phpdoc
1 parent 7dbbab2 commit 7ae9470

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

Diff for: src/Parser/Comment/RegexCommentParser.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -79,18 +79,18 @@ private function lex(string $docblock): iterable
7979
* Returns significant parts of the DocBlock comment with their offsets of
8080
* the returned section, relative to the beginning.
8181
*
82-
* ```php
82+
* ```
8383
* $result = $reader->read(<<<'DOC'
8484
* /**
8585
* * Example line 1
8686
* *
87-
* * @tag1 type Description of tag1
88-
* *
87+
* * @tag1 type Description of tag1
88+
* *​/
8989
* DOC);
9090
*
9191
* // The $result contains:
9292
* // object(Segment) { offset: 7, text: 'Example line 1' }
93-
* // object(Segment) { offset: 28, text: '@tag1 type Description of tag1' }
93+
* // object(Segment) { offset: 28, text: '@tag1 type Description of tag1' }
9494
* ```
9595
*
9696
* @return iterable<array-key, Segment>

Diff for: src/Parser/Description/DescriptionParserInterface.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ interface DescriptionParserInterface
1313
*
1414
* ```php
1515
* $description = $parser->parse(<<<'DOC'
16-
* This is a description with {@link Example}.
16+
* This is a description with {@link Example}.
1717
* DOC);
1818
*
1919
* // $description MAY contains:

Diff for: src/Parser/Tag/TagParserInterface.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ interface TagParserInterface
1212
/**
1313
* Returns concrete tag instance by the tag signature.
1414
*
15-
* ```php
16-
* $tag = $parser->parse('@param string $tag');
15+
* ```
16+
* $tag = $parser->parse('@param string $tag');
1717
*
1818
* // $tag may contains:
1919
* // object(ParamTag) {

0 commit comments

Comments
 (0)