Permalink
Browse files

Clean up phpDoc on get() a little more

  • Loading branch information...
1 parent f918194 commit 76b6daefaa4009fdd8de72b8f25259200a66d477 @bharat bharat committed Nov 28, 2010
Showing with 10 additions and 10 deletions.
  1. +6 −5 modules/gallery/helpers/item_rest.php
  2. +4 −5 modules/gallery/helpers/items_rest.php
@@ -23,18 +23,19 @@ class item_rest_Core {
* query the collection. You can specify them in any combination.
*
* scope=direct
- * only return items that are immediately under this one
+ * Only return items that are immediately under this one
* scope=all
- * return items anywhere under this one
+ * Return items anywhere under this one
*
* name=<substring>
- * only return items where the name contains this substring
+ * Only return items where the name contains this substring
*
* random=true
- * return a single random item
+ * Return a single random item
*
* type=<comma separate list of photo, movie or album>
- * limit the type to types in this list. eg, "type=photo,movie"
+ * Limit the type to types in this list, eg: "type=photo,movie".
+ * Also limits the types returned in the member collections (same behaviour as item_rest).
*/
static function get($request) {
$item = rest::resolve($request->url);
@@ -26,15 +26,14 @@ class items_rest_Core {
* ancestors_for parameter makes no sense and will be ignored.
*
* urls=["url1","url2","url3"]
- * return items that match the specified urls. Typically used to return the member detail
+ * Return items that match the specified urls. Typically used to return the member detail
*
* ancestors_for=url
- * return the ancestors of the specified item
+ * Return the ancestors of the specified item
*
* type=<comma separate list of photo, movie or album>
- * limit the type to types in this list. eg, "type=photo,movie"
- * Also limits the types returned in the member collections (same
- * behaviour as item_rest).
+ * Limit the type to types in this list, eg: "type=photo,movie".
+ * Also limits the types returned in the member collections (same behaviour as item_rest).
* Ignored if ancestors_for is set.
*/
static function get($request) {

0 comments on commit 76b6dae

Please sign in to comment.