From eb38c7b990cbdea9abb948dec8181975c7347a5d Mon Sep 17 00:00:00 2001 From: "Michael J. Rubinsky" Date: Wed, 6 May 2009 10:54:20 -0400 Subject: [PATCH] Fill in some missing phpdoc --- kronolith/lib/Tagger.php | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/kronolith/lib/Tagger.php b/kronolith/lib/Tagger.php index 4a4456e0b..f3c83f854 100644 --- a/kronolith/lib/Tagger.php +++ b/kronolith/lib/Tagger.php @@ -131,9 +131,9 @@ class Kronolith_Tagger * Tag the given resource with *only* the tags provided, removing any tags * that are already present but not in the list. * - * @param $localId - * @param $tags - * @param $content_type + * @param string $localId The identifier for the kronolith object. + * @param mixed $tags Either a tag_id, tag_name, or array of tag_ids. + * @param $content_type The type of object that $localId represents. * * @return void */ @@ -192,14 +192,24 @@ class Kronolith_Tagger /** * List tags beginning with $token. Used for autocomplete code. * - * @param $token - * @return unknown_type + * @param string $token The token to match the start of the tag with. + * + * @return A tag_id => tag_name hash */ public function listTags($token) { return self::$_tagger->getTags(array('q' => $token)); } + /** + * Return the data needed to build a tag cloud based on the passed in + * user's tag data set. + * + * @param string $user The user whose tags should be included. + * @param integer $limit The maximum number of tags to include. + * + * @return An array of hashes, each containing tag_id, tag_name, and count. + */ public function getCloud($user, $limit = 5) { return self::$_tagger->getTagCloud(array('userId' => $user, -- 2.11.0