php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-12-19 07:07:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

improved phpdoc command

Browse Source
This commit is contained in:
Carsten Brandt
2014-04-23 02:13:53 +02:00
parent 83a63f2346
commit 12d34849cc
2 changed files with 44 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
build/controllers/PhpDocController.php
View File

@@ -84,6 +84,7 @@ class PhpDocController extends Controller
$lines = preg_split('/(\r\n|\n|\r)/', $contents);
$this->fixFileDoc($lines);
$this->fixDocBlockIndentation($lines);
$newContent = implode("\n", $lines);
if ($sha !== sha1($newContent)) {
@@ -194,6 +195,48 @@ class PhpDocController extends Controller
}
}
/**
* Markdown aware fix of whitespace issues in doc comments
*/
protected function fixDocBlockIndentation(&$lines)
{
$docBlock = false;
$codeBlock = false;
$listIndent = false;
$indent = '';
foreach($lines as $i => $line) {
if (preg_match('~^(\s+)/\*\*$~', $line, $matches)) {
$docBlock = true;
$indent = $matches[1];
} elseif (preg_match('~^(\s+)\*/~', $line)) {
$docBlock = false;
$codeBlock = false;
$listIndent = '';
$lines[$i] = $indent . ' */';
} elseif ($docBlock) {
$docLine = trim($line, " \t*");
if (empty($docLine)) {
$listIndent = '';
} elseif ($docLine[0] === '@') {
$listIndent = '';
$codeBlock = false;
$docLine = preg_replace('/\s+/', ' ', $docLine);
} elseif (preg_match('/^(~~~|```)/', $docLine)) {
$codeBlock = !$codeBlock;
} elseif (preg_match('/^([0-9]+\.|-|\*|\+) /', $docLine, $matches)) {
$listIndent = str_repeat(' ', strlen($matches[0]));
$lines[$i] = $indent . ' * ' . $docLine;
continue;
}
if ($codeBlock) {
$lines[$i] = rtrim($indent . ' * ' . substr(ltrim($line), 2));
} else {
$lines[$i] = rtrim($indent . ' * ' . $listIndent . $docLine);
}
}
}
}
protected function updateClassPropertyDocs($file, $className, $propertyDoc)
{
$ref = new \ReflectionClass($className);