Skip to content

Commit a4107ac

Browse files
committed
Restored indentation in multi-line tag descriptions, and applied them where they were previously missing.
1 parent d611970 commit a4107ac

File tree

3 files changed

+20
-18
lines changed

3 files changed

+20
-18
lines changed

src/phpDocumentor/Reflection/DocBlock.php

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ class DocBlock implements \Reflector
2525
protected $short_description = '';
2626

2727
/**
28-
* @var \phpDocumentor\Reflection\DocBlock\LongDescription The actual description
29-
* for this docblock.
28+
* @var \phpDocumentor\Reflection\DocBlock\LongDescription The actual
29+
* description for this docblock.
3030
*/
3131
protected $long_description = null;
3232

3333
/**
3434
* @var \phpDocumentor\Reflection\DocBlock\Tags[] An array containing all
35-
* the tags in this docblock; except inline.
35+
* the tags in this docblock; except inline.
3636
*/
3737
protected $tags = array();
3838

@@ -53,15 +53,15 @@ class DocBlock implements \Reflector
5353
* information.
5454
*
5555
* @param \Reflector|string $docblock A docblock comment (including
56-
* asterisks) or reflector supporting the getDocComment method.
56+
* asterisks) or reflector supporting the getDocComment method.
5757
* @param string $namespace The namespace where this
58-
* DocBlock resides in; defaults to `\`.
58+
* DocBlock resides in; defaults to `\`.
5959
* @param string[] $namespace_aliases A list of namespace aliases
60-
* as provided by the `use` keyword; the key of the array is the alias name
61-
* or last part of the alias array if no alias name is provided.
60+
* as provided by the `use` keyword; the key of the array is the alias
61+
* name or last part of the alias array if no alias name is provided.
6262
*
6363
* @throws \InvalidArgumentException if the given argument does not have the
64-
* getDocComment method.
64+
* getDocComment method.
6565
*/
6666
public function __construct(
6767
$docblock,
@@ -125,7 +125,7 @@ protected function cleanInput($comment)
125125
* @param string $comment Comment to split into the sub-parts.
126126
*
127127
* @author RichardJ Special thanks to RichardJ for the regex responsible
128-
* for the split/
128+
* for the split.
129129
*
130130
* @return string[] containing the short-, long description and an element
131131
* containing the tags.
@@ -312,9 +312,10 @@ public function hasTag($name)
312312
* @param string $type Type to expand into full namespaced
313313
* equivalent.
314314
* @param string[] $ignore_keywords Whether to ignore given keywords, when
315-
* null it will use the default keywords: 'string', 'int', 'integer',
316-
* 'bool', 'boolean', 'float', 'double', 'object', 'mixed', 'array',
317-
* 'resource', 'void', 'null', 'callback', 'false', 'true'.
315+
* null it will use the default keywords:
316+
* 'string', 'int', 'integer', 'bool', 'boolean', 'float', 'double',
317+
* 'object', 'mixed', 'array', 'resource', 'void', 'null', 'callback',
318+
* 'false', 'true', 'self', '$this', 'callable'.
318319
* Default value for this parameter is null.
319320
*
320321
* @return string
@@ -327,9 +328,9 @@ public function expandType($type, $ignore_keywords = null)
327328

328329
if ($ignore_keywords === null) {
329330
$ignore_keywords = array(
330-
'string', 'int', 'integer', 'bool', 'boolean', 'float', 'double',
331-
'object', 'mixed', 'array', 'resource', 'void', 'null',
332-
'callback', 'false', 'true', 'self', '$this', 'callable'
331+
'string', 'int', 'integer', 'bool', 'boolean', 'float',
332+
'double', 'object', 'mixed', 'array', 'resource', 'void',
333+
'null', 'callback', 'false', 'true', 'self', '$this', 'callable'
333334
);
334335
}
335336

src/phpDocumentor/Reflection/DocBlock/LongDescription.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public function getContents()
5555
* Returns the parsed text of this description.
5656
*
5757
* @return array An array of strings and tag objects, in the order they
58-
* occur within the description.
58+
* occur within the description.
5959
*/
6060
public function getParsedContents()
6161
{
@@ -109,7 +109,8 @@ public function getFormattedContents()
109109
/**
110110
* Builds a string representation of this object.
111111
*
112-
* @todo determine the exact format as used by PHP Reflection and implement it.
112+
* @todo determine the exact format as used by PHP Reflection
113+
* and implement it.
113114
*
114115
* @return void
115116
*/

src/phpDocumentor/Reflection/DocBlock/Tag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ public function getDescription()
120120
* Returns the parsed text of this description.
121121
*
122122
* @return array An array of strings and tag objects, in the order they
123-
* occur within the description.
123+
* occur within the description.
124124
*/
125125
public function getParsedDescription()
126126
{

0 commit comments

Comments
 (0)