From: Michael J. Rubinsky <mrubinsk@horde.org>
Date: Wed, 6 May 2009 14:54:20 +0000 (-0400)
Subject: Fill in some missing phpdoc
X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=eb38c7b990cbdea9abb948dec8181975c7347a5d;p=horde.git

Fill in some missing phpdoc
---

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,