summaryrefslogtreecommitdiffstats
path: root/lib/public/iurlgenerator.php
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
committerMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
commit7644950b48b094bfe5675348aefb7cf5747d325b (patch)
treea1792e21239a86f471da99b454134a5d8533ef77 /lib/public/iurlgenerator.php
parent8653da6c16597959c7bd0f0b202747ff96204575 (diff)
downloadnextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.tar.gz
nextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.zip
Add @since tags to all methods in public namespace
* enhance the app development experience - you can look up the method introduction right inside the code without searching via git blame * easier to write apps for multiple versions
Diffstat (limited to 'lib/public/iurlgenerator.php')
-rw-r--r--lib/public/iurlgenerator.php7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/public/iurlgenerator.php b/lib/public/iurlgenerator.php
index 57bf73f9d24..4324a4b5a97 100644
--- a/lib/public/iurlgenerator.php
+++ b/lib/public/iurlgenerator.php
@@ -34,6 +34,7 @@ namespace OCP;
/**
* Class to generate URLs
+ * @since 6.0.0
*/
interface IURLGenerator {
/**
@@ -41,6 +42,7 @@ interface IURLGenerator {
* @param string $routeName the name of the route
* @param array $arguments an array with arguments which will be filled into the url
* @return string the url
+ * @since 6.0.0
*/
public function linkToRoute($routeName, $arguments = array());
@@ -49,6 +51,7 @@ interface IURLGenerator {
* @param string $routeName the name of the route
* @param array $arguments an array with arguments which will be filled into the url
* @return string the absolute url
+ * @since 8.0.0
*/
public function linkToRouteAbsolute($routeName, $arguments = array());
@@ -57,6 +60,7 @@ interface IURLGenerator {
* @param string $appName the name of the app
* @param string $file the name of the file
* @return string the url
+ * @since 6.0.0
*/
public function linkTo($appName, $file);
@@ -65,6 +69,7 @@ interface IURLGenerator {
* @param string $appName the name of the app
* @param string $file the name of the file
* @return string the url
+ * @since 6.0.0
*/
public function imagePath($appName, $file);
@@ -73,12 +78,14 @@ interface IURLGenerator {
* Makes an URL absolute
* @param string $url the url in the ownCloud host
* @return string the absolute version of the url
+ * @since 6.0.0
*/
public function getAbsoluteURL($url);
/**
* @param string $key
* @return string url to the online documentation
+ * @since 8.0.0
*/
public function linkToDocs($key);
}