From cc8a4511fea5108cd088d49a27cb34a59d7d59e5 Mon Sep 17 00:00:00 2001
From: Bart Visscher <bartv@thisnet.nl>
Date: Tue, 15 Apr 2014 18:00:38 +0200
Subject: [PATCH] Fix PHPdoc in lib/public
using scrutinizer patch
---
lib/public/route/iroute.php | 6 ++++++
lib/public/route/irouter.php | 6 ++++++
lib/public/template.php | 2 +-
3 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/lib/public/route/iroute.php b/lib/public/route/iroute.php
index 66fdb84182..d5610e762a 100644
--- a/lib/public/route/iroute.php
+++ b/lib/public/route/iroute.php
@@ -10,6 +10,7 @@ namespace OCP\Route;
interface IRoute {
/**
* Specify PATCH as the method to use with this route
+ * @return \OCP\Route\IRoute
*/
public function patch();
@@ -26,21 +27,25 @@ interface IRoute {
* it is called directly
*
* @param $file
+ * @return void
*/
public function actionInclude($file);
/**
* Specify GET as the method to use with this route
+ * @return \OCP\Route\IRoute
*/
public function get();
/**
* Specify POST as the method to use with this route
+ * @return \OCP\Route\IRoute
*/
public function post();
/**
* Specify DELETE as the method to use with this route
+ * @return \OCP\Route\IRoute
*/
public function delete();
@@ -74,6 +79,7 @@ interface IRoute {
/**
* Specify PUT as the method to use with this route
+ * @return \OCP\Route\IRoute
*/
public function put();
}
diff --git a/lib/public/route/irouter.php b/lib/public/route/irouter.php
index 125cd29e81..1c003c7b4b 100644
--- a/lib/public/route/irouter.php
+++ b/lib/public/route/irouter.php
@@ -17,10 +17,14 @@ interface IRouter {
*/
public function getRoutingFiles();
+ /**
+ * @return string
+ */
public function getCacheKey();
/**
* loads the api routes
+ * @return void
*/
public function loadRoutes($app = null);
@@ -28,6 +32,7 @@ interface IRouter {
* Sets the collection to use for adding routes
*
* @param string $name Name of the collection to use.
+ * @return void
*/
public function useCollection($name);
@@ -47,6 +52,7 @@ interface IRouter {
*
* @param string $url The url to find
* @throws \Exception
+ * @return void
*/
public function match($url);
diff --git a/lib/public/template.php b/lib/public/template.php
index 9a994c1bea..6cc984b12d 100644
--- a/lib/public/template.php
+++ b/lib/public/template.php
@@ -67,7 +67,7 @@ function preview_icon( $path ) {
* Returns the path to the preview of the image.
* @param string $path of file
* @param string $token
- * @return link to the preview
+ * @return string link to the preview
*/
function publicPreview_icon ( $path, $token ) {
return(\publicPreview_icon( $path, $token ));
--
GitLab