updated api docs

This commit is contained in:
Bernhard Posselt
2013-01-30 17:19:03 +01:00
parent cfadf99f89
commit fa1c768a44
3 changed files with 10 additions and 6 deletions

View File

@@ -14,5 +14,7 @@ entry in the database
.. php:method:: __construct($msg)
:param mixed $msg:
:param string $msg: the error message
Constructor

View File

@@ -14,5 +14,7 @@ row
.. php:method:: __construct($msg)
:param mixed $msg:
:param string $msg: the error message
Constructor

View File

@@ -17,7 +17,7 @@ https://docs.djangoproject.com/en/dev/topics/http/middleware/
.. php:method:: beforeController($controller, $methodName)
:param \\OCA\\AppFramework\\Controller\\Controller $controller: the controller that is being called
:param \\OCA\\AppFramework\\Middleware\\Controller $controller: the controller that is being called
:param string $methodName: the name of the method that will be called on the controller
@@ -26,7 +26,7 @@ https://docs.djangoproject.com/en/dev/topics/http/middleware/
.. php:method:: afterException($controller, $methodName, $exception)
:param \\OCA\\AppFramework\\Controller\\Controller $controller: the controller that is being called
:param \\OCA\\AppFramework\\Middleware\\Controller $controller: the controller that is being called
:param string $methodName: the name of the method that will be called on the controller
:param \\Exception $exception: the thrown exception
:returns \\OCA\\AppFramework\\Http\\Response: a Response object or null in case that the exception could not be handled
@@ -38,7 +38,7 @@ https://docs.djangoproject.com/en/dev/topics/http/middleware/
.. php:method:: afterController($controller, $methodName, $response)
:param \\OCA\\AppFramework\\Controller\\Controller $controller: the controller that is being called
:param \\OCA\\AppFramework\\Middleware\\Controller $controller: the controller that is being called
:param string $methodName: the name of the method that will be called on the controller
:param \\OCA\\AppFramework\\Http\\Response $response: the generated response from the controller
:returns \\OCA\\AppFramework\\Http\\Response: a Response object
@@ -50,7 +50,7 @@ https://docs.djangoproject.com/en/dev/topics/http/middleware/
.. php:method:: beforeOutput($controller, $methodName, $output)
:param \\OCA\\AppFramework\\Controller\\Controller $controller: the controller that is being called
:param \\OCA\\AppFramework\\Middleware\\Controller $controller: the controller that is being called
:param string $methodName: the name of the method that will be called on the controller
:param string $output: the generated output from a response
:returns string: the output that should be printed