Commit f7a5c29e by Carsten Brandt

apidoc cleanup

parent 367744ff
...@@ -113,7 +113,7 @@ abstract class BaseController extends Controller ...@@ -113,7 +113,7 @@ abstract class BaseController extends Controller
} }
/** /**
* @inheritdoc * @param string $template
* @return BaseRenderer * @return BaseRenderer
*/ */
protected abstract function findRenderer($template); protected abstract function findRenderer($template);
......
...@@ -95,17 +95,17 @@ class BaseDoc extends Object ...@@ -95,17 +95,17 @@ class BaseDoc extends Object
} }
} }
// TODO // TODO implement
public function loadSource($reflection) // public function loadSource($reflection)
{ // {
$this->sourcePath = str_replace('\\', '/', str_replace(YII_PATH, '', $reflection->getFileName())); // $this->sourceFile;
$this->startLine = $reflection->getStartLine(); // $this->startLine;
$this->endLine = $reflection->getEndLine(); // $this->endLine;
} // }
//
public function getSourceCode() // public function getSourceCode()
{ // {
$lines = file(YII_PATH . $this->sourcePath); // $lines = file(YII_PATH . $this->sourcePath);
return implode("", array_slice($lines, $this->startLine - 1, $this->endLine - $this->startLine + 1)); // return implode("", array_slice($lines, $this->startLine - 1, $this->endLine - $this->startLine + 1));
} // }
} }
...@@ -299,7 +299,8 @@ class Context extends Component ...@@ -299,7 +299,8 @@ class Context extends Component
/** /**
* @param ClassDoc $classA * @param ClassDoc $classA
* @param ClassDoc $classB * @param ClassDoc|string $classB
* @return boolean
*/ */
protected function isSubclassOf($classA, $classB) protected function isSubclassOf($classA, $classB)
{ {
......
...@@ -118,7 +118,7 @@ class SideNavWidget extends \yii\bootstrap\Widget ...@@ -118,7 +118,7 @@ class SideNavWidget extends \yii\bootstrap\Widget
/** /**
* Renders a widget's item. * Renders a widget's item.
* @param string|array $item the item to render. * @param string|array $item the item to render.
* @param bool $collapsed whether to collapse item if not active * @param boolean $collapsed whether to collapse item if not active
* @throws \yii\base\InvalidConfigException * @throws \yii\base\InvalidConfigException
* @return string the rendering result. * @return string the rendering result.
* @throws InvalidConfigException if label is not defined * @throws InvalidConfigException if label is not defined
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment