aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--lib/public/appframework/app.php14
1 files changed, 13 insertions, 1 deletions
diff --git a/lib/public/appframework/app.php b/lib/public/appframework/app.php
index 1f82f8da889..1021a21397f 100644
--- a/lib/public/appframework/app.php
+++ b/lib/public/appframework/app.php
@@ -49,7 +49,19 @@ class App {
}
/**
- * This function is to be called
+ * This function is to be called to create single routes and restful routes based on the given $routes array.
+ *
+ * Example code in routes.php of tasks app (it will register two restful resources):
+ * $routes = array(
+ * 'resources' => array(
+ * 'lists' => array('url' => '/tasklists'),
+ * 'tasks' => array('url' => '/tasklists/{listId}/tasks')
+ * )
+ * );
+ *
+ * $a = new TasksApp();
+ * $a->registerRoutes($this, $routes);
+ *
* @param \OC_Router $router
* @param array $routes
*/