Fix PHPdoc in lib/public

using scrutinizer patch
This commit is contained in:
Bart Visscher 2014-04-15 18:00:38 +02:00
parent a4b7f5155f
commit cc8a4511fe
3 changed files with 13 additions and 1 deletions

View File

@ -10,6 +10,7 @@ namespace OCP\Route;
interface IRoute { interface IRoute {
/** /**
* Specify PATCH as the method to use with this route * Specify PATCH as the method to use with this route
* @return \OCP\Route\IRoute
*/ */
public function patch(); public function patch();
@ -26,21 +27,25 @@ interface IRoute {
* it is called directly * it is called directly
* *
* @param $file * @param $file
* @return void
*/ */
public function actionInclude($file); public function actionInclude($file);
/** /**
* Specify GET as the method to use with this route * Specify GET as the method to use with this route
* @return \OCP\Route\IRoute
*/ */
public function get(); public function get();
/** /**
* Specify POST as the method to use with this route * Specify POST as the method to use with this route
* @return \OCP\Route\IRoute
*/ */
public function post(); public function post();
/** /**
* Specify DELETE as the method to use with this route * Specify DELETE as the method to use with this route
* @return \OCP\Route\IRoute
*/ */
public function delete(); public function delete();
@ -74,6 +79,7 @@ interface IRoute {
/** /**
* Specify PUT as the method to use with this route * Specify PUT as the method to use with this route
* @return \OCP\Route\IRoute
*/ */
public function put(); public function put();
} }

View File

@ -17,10 +17,14 @@ interface IRouter {
*/ */
public function getRoutingFiles(); public function getRoutingFiles();
/**
* @return string
*/
public function getCacheKey(); public function getCacheKey();
/** /**
* loads the api routes * loads the api routes
* @return void
*/ */
public function loadRoutes($app = null); public function loadRoutes($app = null);
@ -28,6 +32,7 @@ interface IRouter {
* Sets the collection to use for adding routes * Sets the collection to use for adding routes
* *
* @param string $name Name of the collection to use. * @param string $name Name of the collection to use.
* @return void
*/ */
public function useCollection($name); public function useCollection($name);
@ -47,6 +52,7 @@ interface IRouter {
* *
* @param string $url The url to find * @param string $url The url to find
* @throws \Exception * @throws \Exception
* @return void
*/ */
public function match($url); public function match($url);

View File

@ -67,7 +67,7 @@ function preview_icon( $path ) {
* Returns the path to the preview of the image. * Returns the path to the preview of the image.
* @param string $path of file * @param string $path of file
* @param string $token * @param string $token
* @return link to the preview * @return string link to the preview
*/ */
function publicPreview_icon ( $path, $token ) { function publicPreview_icon ( $path, $token ) {
return(\publicPreview_icon( $path, $token )); return(\publicPreview_icon( $path, $token ));