mirrors/barryvdh_ReflectionDocBlock
1
0
Fork 0
mirror of https://github.com/barryvdh/ReflectionDocBlock.git synced 2026-08-18 01:57:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added "{}" around all double quoted variables, for readability's sake;

Browse Source 
Performance improvement in Serializer - wrap length is calculated once during the text portion only. Tags reuse the result. Also no "prefix" adding in tags - the name is simply added before wrapping.
This commit is contained in:
Vasil Rangelov
2013-05-27 02:04:23 +03:00
parent 4a7affe15b
commit ac6e37af97
2 changed files with 10 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/phpDocumentor/Reflection/DocBlock.php
+1 -1
View File
@@ -243,7 +243,7 @@ class DocBlock implements \Reflector
$long = $this->getLongDescription()->getContents(); $long = $this->getLongDescription()->getContents();
if ($long) { if ($long) {
return $short . "\n\n" . $long; return "{$short}\n\n{$long}";
} else { } else {
return $short; return $short;
} }
src/phpDocumentor/Reflection/DocBlock/Serializer.php
+9 -22
View File
@@ -172,36 +172,23 @@ class Serializer
$text = $docblock->getText(); $text = $docblock->getText();
if ($this->lineLength) { if ($this->lineLength) {
$text = wordwrap( //3 === strlen(' * ')
$text, $wrapLength = $this->lineLength - strlen($indent) - 3;
$this->lineLength - strlen($indent) - 3/*strlen(' * ')*/ $text = wordwrap($text, $wrapLength);
);
} }
$text = str_replace("\n", "\n$indent * ", $text); $text = str_replace("\n", "\n{$indent} * ", $text);
$comment = "$firstIndent/**\n$indent * $text\n$indent *\n"; $comment = "{$firstIndent}/**\n{$indent} * {$text}\n{$indent} *\n";
/** @var Tag $tag */ /** @var Tag $tag */
foreach ($docblock->getTags() as $tag) { foreach ($docblock->getTags() as $tag) {
$tagName = $tag->getName(); $tagText = "@{$tag->getName()} {$tag->getContent()}";
$prefixLength = 1/*strlen('@')*/ + strlen($tagName);
//Added to take the first line of the tag into account.
$tagContent = str_repeat(' ', $prefixLength) . $tag->getContent();
if ($this->lineLength) { if ($this->lineLength) {
$tagContent = wordwrap( $tagText = wordwrap($tagText, $wrapLength);
$tagContent,
$this->lineLength - strlen($indent) - 3/*strlen(' * ')*/
);
} }
$tagText = str_replace("\n", "\n{$indent} * ", $tagText);
//Clean up the prefix. $comment .= "{$indent} * {$tagText}\n";
substr_replace($tagContent, '', 0, $prefixLength);
$tagContent = str_replace("\n", "\n$indent * ", $tagContent);
$comment .= "$indent * @{$tagName} {$tagContent}\n";
} }
$comment .= $indent . ' */'; $comment .= $indent . ' */';