adding documentation for registerRoutes()

remotes/origin/stable6
Thomas Müller 2013-11-25 17:15:08 +07:00
parent 993fea2f05
commit 1fdd2ac7ee
1 changed files with 13 additions and 1 deletions

@ -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
*/