summaryrefslogtreecommitdiffstats
path: root/lib/public/appframework/app.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/appframework/app.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/appframework/app.php')
-rw-r--r--lib/public/appframework/app.php6
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/public/appframework/app.php b/lib/public/appframework/app.php
index d070e0d4c83..bf4e14961f5 100644
--- a/lib/public/appframework/app.php
+++ b/lib/public/appframework/app.php
@@ -38,6 +38,7 @@ use OC\AppFramework\routing\RouteConfig;
*
* Any application must inherit this call - all controller instances to be used are
* to be registered using IContainer::registerService
+ * @since 6.0.0
*/
class App {
@@ -50,6 +51,7 @@ class App {
* @param string $topNamespace the namespace which should be prepended to
* the transformed app id, defaults to OCA\
* @return string the starting namespace for the app
+ * @since 8.0.0
*/
public static function buildAppNamespace($appId, $topNamespace='OCA\\') {
return \OC\AppFramework\App::buildAppNamespace($appId, $topNamespace);
@@ -58,6 +60,7 @@ class App {
/**
* @param array $urlParams an array with variables extracted from the routes
+ * @since 6.0.0
*/
public function __construct($appName, $urlParams = array()) {
$this->container = new \OC\AppFramework\DependencyInjection\DIContainer($appName, $urlParams);
@@ -67,6 +70,7 @@ class App {
/**
* @return IAppContainer
+ * @since 6.0.0
*/
public function getContainer() {
return $this->container;
@@ -88,6 +92,7 @@ class App {
*
* @param \OCP\Route\IRouter $router
* @param array $routes
+ * @since 6.0.0
*/
public function registerRoutes($router, $routes) {
$routeConfig = new RouteConfig($this->container, $router, $routes);
@@ -123,6 +128,7 @@ class App {
* @param string $controllerName the name of the controller under which it is
* stored in the DI container
* @param string $methodName the method that you want to call
+ * @since 6.0.0
*/
public function dispatch($controllerName, $methodName) {
\OC\AppFramework\App::main($controllerName, $methodName, $this->container);