small phpdoc tweaks while I'm poking
authorMichael J. Rubinsky <mrubinsk@horde.org>
Tue, 21 Dec 2010 20:46:04 +0000 (15:46 -0500)
committerMichael J. Rubinsky <mrubinsk@horde.org>
Tue, 21 Dec 2010 21:09:52 +0000 (16:09 -0500)
ansel/lib/Tagger.php
ansel/lib/Widget.php
ansel/lib/Widget/Base.php
ansel/lib/Widget/SimilarPhotos.php

index 0efc8aa..f54a8b7 100644 (file)
@@ -1,6 +1,7 @@
 <?php
 /**
- * The Ansel_Tagger:: class provides logic for dealing with tags within Ansel
+ * The Ansel_Tagger:: class wraps Ansel's interaction with the Content/Tagger
+ * system.
  *
  * Copyright 2010 The Horde Project (http://www.horde.org/)
  *
@@ -8,6 +9,7 @@
  * did not receive this file, see http://www.fsf.org/copyleft/gpl.html.
  *
  * @author  Michael J. Rubinsky <mrubinsk@horde.org>
+ * @category Horde
  * @license  http://www.fsf.org/copyleft/gpl.html GPL
  * @package  Ansel
  */
@@ -239,7 +241,7 @@ class Ansel_Tagger
      *
      * @param string $token  The token to match the start of the tag with.
      *
-     * @return A tag_id => tag_name hash
+     * @return array  A tag_id => tag_name hash
      * @throws Ansel_Exception
      */
     public function listTags($token)
index ad93b09..6eafcd1 100644 (file)
@@ -9,6 +9,8 @@
  * did not receive this file, see http://www.fsf.org/copyleft/gpl.html.
  *
  * @author Michael J. Rubinsky <mrubinsk@horde.org>
+ * @category Horde
+ * @license http://www.fsf.org/copyleft/gpl.html GPL
  * @package Ansel
  */
 class Ansel_Widget
index 4fae1ca..5be50fb 100644 (file)
@@ -9,6 +9,8 @@
  * did not receive this file, see http://www.fsf.org/copyleft/gpl.html.
  *
  * @author Michael J. Rubinsky <mrubinsk@horde.org>
+ * @category Horde
+ * @license http://www.fsf.org/copyleft/gpl.html GPL
  * @package Ansel
  */
 abstract class Ansel_Widget_Base
index 7bcb64f..bfcc15a 100755 (executable)
@@ -4,6 +4,8 @@
  * thumbnails of images that are similar, based on tags.
  *
  * @author Michael J. Rubinsky <mrubinsk@horde.org>
+ * @category Horde
+ * @license http://www.fsf.org/copyleft/gpl.html GPL
  * @package Ansel
  */
 class Ansel_Widget_SimilarPhotos extends Ansel_Widget_Base
@@ -11,7 +13,7 @@ class Ansel_Widget_SimilarPhotos extends Ansel_Widget_Base
     /**
      * Array of views that this widget may appear in.
      *
-     * @var unknown_type
+     * @var array
      */
     protected $_supported_views = array('Image');
 
@@ -19,6 +21,7 @@ class Ansel_Widget_SimilarPhotos extends Ansel_Widget_Base
      * Constructor
      *
      * @param array $params  Any parameters for this widget
+     *
      * @return Ansel_Widget_SimilarPhotos
      */
     public function __construct($params)