correct typos in doc-tags and add missing tags

This commit is contained in:
coderkun 2014-09-16 12:42:19 +02:00
commit 857dc97a14
12 changed files with 24 additions and 10 deletions

View file

@ -27,7 +27,8 @@
/** /**
* Get the layout if it was explicitly defined. * Get the layout if it was explicitly defined.
* *
* @return string Layout of the IntermediateAgent * @param string $agentName Name of Agent to get Layout for
* @return string Layout of the IntermediateAgent
*/ */
public static function getLayout($agentName) public static function getLayout($agentName)
{ {

View file

@ -74,7 +74,7 @@
* @throws ControllerNotValidException * @throws ControllerNotValidException
* @throws ControllerNotFoundException * @throws ControllerNotFoundException
* @param Request $request Current request * @param Request $request Current request
* @param Response $respone Current response * @param Response $response Current response
* @param Logger $log Log-system * @param Logger $log Log-system
*/ */
protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null) protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null)

View file

@ -223,7 +223,7 @@
* Handle a error which cannot be handles by the system (and * Handle a error which cannot be handles by the system (and
* HTTP 503). * HTTP 503).
* *
* $param Exception $exception Occurred exception * @param \Exception $exception Occurred exception
*/ */
private function errorService($exception) private function errorService($exception)
{ {

View file

@ -107,7 +107,7 @@
* @throws ControllerNotFoundException * @throws ControllerNotFoundException
* @param string $agentName Name of the Agent to instantiate * @param string $agentName Name of the Agent to instantiate
* @param Request $request Current request * @param Request $request Current request
* @param Response $respone Current respone * @param Response $response Current response
* @param Logger $log Log-system * @param Logger $log Log-system
*/ */
public static function factory($agentName, Request $request, Response $response, Logger $log=null) public static function factory($agentName, Request $request, Response $response, Logger $log=null)
@ -165,7 +165,7 @@
* @throws ControllerNotValidException * @throws ControllerNotValidException
* @throws ControllerNotFoundException * @throws ControllerNotFoundException
* @param Request $request Current request * @param Request $request Current request
* @param Response $respone Current response * @param Response $response Current response
* @param Logger $log Log-system * @param Logger $log Log-system
*/ */
protected function __construct(Request $request, Response $response, Logger $log=null) protected function __construct(Request $request, Response $response, Logger $log=null)
@ -500,8 +500,9 @@
/** /**
* Handle the exception of a SubAgent. * Handle the exception of a SubAgent.
* *
* @param string $label Name of the original Agent * @param Agent $subAgent SubAgent to handle error of
* @param Excepiton $exception Occurred exception * @param Request $request Current request
* @param Exception $exception Occurred exception
* @return array InlineError-SubAgent * @return array InlineError-SubAgent
*/ */
private function errorInline($subAgent, $request, $exception) private function errorInline($subAgent, $request, $exception)

View file

@ -54,7 +54,7 @@
* Construct a new API. * Construct a new API.
* *
* @param Request $request Current request * @param Request $request Current request
* @param Response $respone Current response * @param Response $response Current response
*/ */
public function __construct(Request $request, Response $response) public function __construct(Request $request, Response $response)
{ {

View file

@ -27,7 +27,7 @@
* Load a class. * Load a class.
* *
* @throws ClassNotFoundException * @throws ClassNotFoundException
* @param string $className Name of the class to load * @param string $fullClassName Name of the class to load
*/ */
public static function load($fullClassName) public static function load($fullClassName)
{ {

View file

@ -93,6 +93,7 @@
* @param string $controllerName Name of the Controller to instantiate * @param string $controllerName Name of the Controller to instantiate
* @param string $layoutName Name of the current Layout * @param string $layoutName Name of the current Layout
* @param string $action Current Action * @param string $action Current Action
* @param string $agent Name of Agent
*/ */
public static function factory($controllerName, $layoutName, $action, $agent) public static function factory($controllerName, $layoutName, $action, $agent)
{ {

View file

@ -55,6 +55,7 @@
* Instantiate a Driver (Factory Pattern). * Instantiate a Driver (Factory Pattern).
* *
* @param string $driverName Name of the Driver to instantiate * @param string $driverName Name of the Driver to instantiate
* @param mixed $config Driver configuration
*/ */
public static function factory($driverName, $config) public static function factory($driverName, $config)
{ {

View file

@ -46,6 +46,8 @@
* Construct a new exception * Construct a new exception
* *
* @param string $className Name of the class that was not found * @param string $className Name of the class that was not found
* @param string $message Error message (superclass)
* @param int $code Error code (superclass)
*/ */
function __construct($className, $message=self::MESSAGE, $code=self::CODE) function __construct($className, $message=self::MESSAGE, $code=self::CODE)
{ {

View file

@ -46,6 +46,8 @@
* Construct a new exception. * Construct a new exception.
* *
* @param string $className Name of the invalid class * @param string $className Name of the invalid class
* @param string $message Error message (superclass)
* @param int $code Error code (superclass)
*/ */
function __construct($className, $message=self::MESSAGE, $code=self::CODE) function __construct($className, $message=self::MESSAGE, $code=self::CODE)
{ {

View file

@ -160,7 +160,7 @@
/** /**
* Get a GET-parameter. * Get a GET-parameter.
* *
* @param int $index Index of GET-parameter * @param int $key Index of GET-parameter
* @param string $defaultIndex Index of default configuration value for this parameter * @param string $defaultIndex Index of default configuration value for this parameter
* @return string Value of GET-parameter * @return string Value of GET-parameter
*/ */

View file

@ -14,10 +14,16 @@
*/ */
// Directory separator // Directory separator
if(!defined('DS')) { if(!defined('DS')) {
/**
* @internal
*/
define('DS', DIRECTORY_SEPARATOR); define('DS', DIRECTORY_SEPARATOR);
} }
// Root directory // Root directory
if(!defined('ROOT')) { if(!defined('ROOT')) {
/**
* @internal
*/
define('ROOT', dirname(dirname(__FILE__))); define('ROOT', dirname(dirname(__FILE__)));
} }