Использование DocBlocks - как указать, что функция возвращает значение только в некоторых условиях?

Question

У меня есть эта функция:

public function createController()
{
    $valid_controller = class_exists($this->controllerClass)
                    &&  in_array("BaseController", class_parents($this->controllerClass));

    if($valid_controller)
    {
        return new $this->controllerClass($this->urlData["action"]);
    }
    else
    {
        $error = new ErrorController("badurl");
    }
}

и я хочу создать DocBlock, который описывает это. Эта функция возвращает объект контроллера только в том случае, если требуемый контроллер действителен, а если нет, то создает набор ErrorController класс, но не возвращает значение. Как я могу исправить правильное @return тег для этой функции?

Answer 1

PHPDocumentor Docs говорят использовать

@return  null|ControllerClass    text description or explanation here