From 857dc97a14da8e05d08b1463496b9ae280e82ca2 Mon Sep 17 00:00:00 2001 From: coderkun Date: Tue, 16 Sep 2014 12:42:19 +0200 Subject: [PATCH] correct typos in doc-tags and add missing tags --- agents/IntermediateAgent.inc | 3 ++- agents/ToplevelAgent.inc | 2 +- apis/WebApi.inc | 2 +- core/Agent.inc | 9 +++++---- core/Api.inc | 2 +- core/ClassLoader.inc | 2 +- core/Controller.inc | 1 + core/Driver.inc | 1 + exceptions/ClassNotFoundException.inc | 2 ++ exceptions/ClassNotValidException.inc | 2 ++ responses/WebResponse.inc | 2 +- www/index.php | 6 ++++++ 12 files changed, 24 insertions(+), 10 deletions(-) diff --git a/agents/IntermediateAgent.inc b/agents/IntermediateAgent.inc index 7139653d..05dab225 100644 --- a/agents/IntermediateAgent.inc +++ b/agents/IntermediateAgent.inc @@ -27,7 +27,8 @@ /** * 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) { diff --git a/agents/ToplevelAgent.inc b/agents/ToplevelAgent.inc index 9d6d6f8a..d8b21da5 100644 --- a/agents/ToplevelAgent.inc +++ b/agents/ToplevelAgent.inc @@ -74,7 +74,7 @@ * @throws ControllerNotValidException * @throws ControllerNotFoundException * @param Request $request Current request - * @param Response $respone Current response + * @param Response $response Current response * @param Logger $log Log-system */ protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null) diff --git a/apis/WebApi.inc b/apis/WebApi.inc index 6851ee2d..3d6d1b8b 100644 --- a/apis/WebApi.inc +++ b/apis/WebApi.inc @@ -223,7 +223,7 @@ * Handle a error which cannot be handles by the system (and * HTTP 503). * - * $param Exception $exception Occurred exception + * @param \Exception $exception Occurred exception */ private function errorService($exception) { diff --git a/core/Agent.inc b/core/Agent.inc index 00ec1a90..64807338 100644 --- a/core/Agent.inc +++ b/core/Agent.inc @@ -107,7 +107,7 @@ * @throws ControllerNotFoundException * @param string $agentName Name of the Agent to instantiate * @param Request $request Current request - * @param Response $respone Current respone + * @param Response $response Current response * @param Logger $log Log-system */ public static function factory($agentName, Request $request, Response $response, Logger $log=null) @@ -165,7 +165,7 @@ * @throws ControllerNotValidException * @throws ControllerNotFoundException * @param Request $request Current request - * @param Response $respone Current response + * @param Response $response Current response * @param Logger $log Log-system */ protected function __construct(Request $request, Response $response, Logger $log=null) @@ -500,8 +500,9 @@ /** * Handle the exception of a SubAgent. * - * @param string $label Name of the original Agent - * @param Excepiton $exception Occurred exception + * @param Agent $subAgent SubAgent to handle error of + * @param Request $request Current request + * @param Exception $exception Occurred exception * @return array InlineError-SubAgent */ private function errorInline($subAgent, $request, $exception) diff --git a/core/Api.inc b/core/Api.inc index b89b12e7..89da30ba 100644 --- a/core/Api.inc +++ b/core/Api.inc @@ -54,7 +54,7 @@ * Construct a new API. * * @param Request $request Current request - * @param Response $respone Current response + * @param Response $response Current response */ public function __construct(Request $request, Response $response) { diff --git a/core/ClassLoader.inc b/core/ClassLoader.inc index 81cf537a..03570ea2 100644 --- a/core/ClassLoader.inc +++ b/core/ClassLoader.inc @@ -27,7 +27,7 @@ * Load a class. * * @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) { diff --git a/core/Controller.inc b/core/Controller.inc index 47b5e0a5..2a865d53 100644 --- a/core/Controller.inc +++ b/core/Controller.inc @@ -93,6 +93,7 @@ * @param string $controllerName Name of the Controller to instantiate * @param string $layoutName Name of the current Layout * @param string $action Current Action + * @param string $agent Name of Agent */ public static function factory($controllerName, $layoutName, $action, $agent) { diff --git a/core/Driver.inc b/core/Driver.inc index eec59143..8172e587 100644 --- a/core/Driver.inc +++ b/core/Driver.inc @@ -55,6 +55,7 @@ * Instantiate a Driver (Factory Pattern). * * @param string $driverName Name of the Driver to instantiate + * @param mixed $config Driver configuration */ public static function factory($driverName, $config) { diff --git a/exceptions/ClassNotFoundException.inc b/exceptions/ClassNotFoundException.inc index 070f383f..029c3c93 100644 --- a/exceptions/ClassNotFoundException.inc +++ b/exceptions/ClassNotFoundException.inc @@ -46,6 +46,8 @@ * Construct a new exception * * @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) { diff --git a/exceptions/ClassNotValidException.inc b/exceptions/ClassNotValidException.inc index bdd36d5e..212f30df 100644 --- a/exceptions/ClassNotValidException.inc +++ b/exceptions/ClassNotValidException.inc @@ -46,6 +46,8 @@ * Construct a new exception. * * @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) { diff --git a/responses/WebResponse.inc b/responses/WebResponse.inc index 2ca25079..bfe13a9e 100644 --- a/responses/WebResponse.inc +++ b/responses/WebResponse.inc @@ -160,7 +160,7 @@ /** * 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 * @return string Value of GET-parameter */ diff --git a/www/index.php b/www/index.php index 46301a31..728c9ca4 100644 --- a/www/index.php +++ b/www/index.php @@ -14,10 +14,16 @@ */ // Directory separator if(!defined('DS')) { + /** + * @internal + */ define('DS', DIRECTORY_SEPARATOR); } // Root directory if(!defined('ROOT')) { + /** + * @internal + */ define('ROOT', dirname(dirname(__FILE__))); }