OpenBuildings / jam

classes/Kohana/Jam/Behavior/Cascade.php

Doc Comments +5 added lines

@@ -52,6 +52,11 @@
 		return NULL;
 	}
 
+	/**
+	 * @param string $current
+	 *
+	 * @return Jam_Model
+	 */
 	public static function get_current_children($current, array $children = array())
 	{
 		foreach ($children as $model => $associations)

classes/Kohana/Jam/Behavior/Nested.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
 	/**
 	 * $builder->root() select only the root items
 	 *
-	 * @param Jam_Builder    $builder
+	 * @param Database_Query    $builder
 	 * @param Jam_Event_Data $data
 	 * @return Jam_Builder
 	 */

classes/Kohana/Jam/Behavior/Paranoid.php

Doc Comments +1 added lines, -2 removed lines

@@ -87,7 +87,7 @@ 
 	 * $builder->deleted(Jam_Behavior_Paranoid::DELETED),
 	 * $builder->deleted(Jam_Behavior_Paranoid::NORMAL)
 	 *
-	 * @param Jam_Builder    $builder
+	 * @param Database_Query    $builder
 	 * @param Jam_Event_Data $data
 	 * @param string         $paranoid_filter_type
 	 */
@@ -135,7 +135,6 @@ 
 	 * $model->restore_delete() Perform this to "undelete" a model
 	 *
 	 * @param Jam_Model      $model
-	 * @param Jam_Event_Data $data
 	 */
 	public function model_call_restore_delete(Jam_Model $model)
 	{

classes/Kohana/Jam/Behavior/Sluggable.php

Doc Comments +4 added lines, -6 removed lines

@@ -36,8 +36,6 @@ 
 	 *
 	 * It sets the fields used in generating the slug
 	 *
-	 * @param  Jam_Event $event the jam event for the behavior
-	 * @param  Jam_Model      $model The Jam_Model object on which the behavior is applies
 	 * @param  string      $name
 	 * @return void
 	 */
@@ -101,7 +99,7 @@ 
 
 	/**
 	 * Getter for parameter
-	 * @return bool
+	 * @return string
 	 */
 	public function slug()
 	{
@@ -178,7 +176,7 @@ 
 
 	/**
 	 * Generated a find_by_slug method for Jam_Builder
-	 * @param  Jam_Builder    $builder the builder object
+	 * @param  Jam_Query_Builder_Select    $builder the builder object
 	 * @param  string           $slug    the slug to search for
 	 * @param  Jam_Event_Data $data
 	 * @return void
@@ -197,7 +195,7 @@ 
 
 	/**
 	 * Generated a find_by_slug method for Jam_Builder
-	 * @param  Jam_Builder    $builder the builder object
+	 * @param  Jam_Query_Builder_Select    $builder the builder object
 	 * @param  string           $slug    the slug to search for
 	 * @param  Jam_Event_Data $data
 	 * @return void
@@ -212,7 +210,7 @@ 
 
 	/**
 	 * Generates a find_by_slug_insist method for Jam_Builder
-	 * @param  Jam_Builder    $builder the builder object
+	 * @param  Jam_Query_Builder_Select    $builder the builder object
 	 * @param  string           $slug    the slug to search for
 	 * @param  Jam_Event_Data $data
 	 * @return void

classes/Kohana/Jam/Behavior/Sortable.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
 	/**
 	 * $select->order_by_position()
 	 *
-	 * @param Jam_Builder $builder
+	 * @param Database_Query_Builder $builder
 	 */
 	public function builder_call_order_by_position(Database_Query_Builder $builder, Jam_Event_Data $data, $direction = NULL)
 	{

classes/Kohana/Jam/Countcache.php

Doc Comments +8 added lines

@@ -29,11 +29,19 @@
 		return $query->where(':primary_key', 'IN', (array) $ids);
 	}
 
+	/**
+	 * @param string $model
+	 * @param string $counter
+	 */
 	public static function increment($model, $counter, $id)
 	{
 		Jam_CountCache::update_counters($model, $id, array($counter => +1))->execute();
 	}
 
+	/**
+	 * @param string $model
+	 * @param string $counter
+	 */
 	public static function decrement($model, $counter, $id)
 	{
 		Jam_CountCache::update_counters($model, $id, array($counter => -1))->execute();

classes/Kohana/Jam/Errors.php

Doc Comments +7 added lines, -2 removed lines

@@ -63,8 +63,7 @@ 
 	/**
 	 * Tracks a database result
 	 *
-	 * @param  mixed  $result
-	 * @param  mixed  $model
+	 * @param  Jam_Validated  $model
 	 */
 	public function __construct(Jam_Validated $model, $error_filename)
 	{
@@ -90,6 +89,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $attribute
+	 */
 	public function messages($attribute = NULL)
 	{
 		$messages = array();
@@ -243,6 +245,9 @@ 
 		throw new Kohana_Exception('Cannot set the errors directly, must use add() method');
 	}
 
+	/**
+	 * @param integer $offset
+	 */
 	public function offsetExists($offset)
 	{
 	 return isset($this->_container[$offset]);

classes/Kohana/Jam/Event.php

Doc Comments +2 added lines, -2 removed lines

@@ -76,7 +76,7 @@ 
 	 * @param   string  $event
 	 * @param   mixed   $sender
 	 * @param   mixed   $params...
-	 * @return  mixed
+	 * @return  string|null
 	 */
 	public function trigger($event, $sender, $params = array())
 	{
@@ -118,7 +118,7 @@ 
 	 * @param  mixed  $sender Jam_Model, Jam_Builder or Jam_Meta
 	 * @param  string $method
 	 * @param  array  $params passed to the method
-	 * @return mixed          returns the response from the callback
+	 * @return string|null          returns the response from the callback
 	 * @throws Jam_Exception_Methodmissing If no method is found
 	 */
 	public function trigger_callback($type, $sender, $method, $params)

classes/Kohana/Jam/Exception/Event.php

Doc Comments +4 added lines

@@ -12,6 +12,10 @@
 
 	public $event;
 
+	/**
+	 * @param string $message
+	 * @param string $event
+	 */
 	function __construct($message, $event, $fields = NULL)
 	{
 		$fields[':event'] = $this->event = $event;