OpenBuildings / jam

classes/Jam/Exception/Upload.php

Doc Comments +3 added lines

@@ -10,6 +10,9 @@
  */
 class Jam_Exception_Upload extends Kohana_Jam_Exception_Upload {
 	
+	/**
+	 * @param string $message
+	 */
 	function __construct($message, $fields = NULL)
 	{
 		parent::__construct($message, $fields);

classes/Kohana/Jam/Array.php

Doc Comments +2 added lines

@@ -151,6 +151,7 @@ 
 
 	/**
 	 * Implement ArrayAccess. Lazy load with _load_content
+	 * @param integer|null $offset
 	 */
 	public function offsetSet($offset, $value)
 	{
@@ -170,6 +171,7 @@ 
 
 	/**
 	 * Implement ArrayAccess. Lazy load with _load_content
+	 * @param integer $offset
 	 */
 	public function offsetUnset($offset)
 	{

classes/Kohana/Jam/Array/Association.php

Doc Comments +7 added lines, -1 removed lines

@@ -17,6 +17,9 @@ 
 	protected $_association;
 	protected $_parent;
 
+	/**
+	 * @param Jam_Validated $parent
+	 */
 	public function parent($parent = NULL)
 	{
 		if ($parent !== NULL)
@@ -27,6 +30,9 @@ 
 		return $this->_parent;
 	}
 
+	/**
+	 * @param Kohana_Jam_Association_Collection $association
+	 */
 	public function association($association = NULL)
 	{
 		if ($association !== NULL)
@@ -80,7 +86,7 @@ 
 	/**
 	 * Use the association to get the item from the collection
 	 * @param  integer $offset
-	 * @return mixed
+	 * @return Jam_Model
 	 */
 	public function offsetGet($offset)
 	{

classes/Kohana/Jam/Array/Model.php

Doc Comments +5 added lines, -1 removed lines

@@ -79,7 +79,7 @@ 
 
 	/**
 	 * Getter of the meta object for this iterator (based on $_model)
-	 * @return Jam_Model
+	 * @return Jam_Meta
 	 * @throws Kohana_Exception If $_model not present
 	 */
 	public function meta()
@@ -248,6 +248,10 @@ 
 		return NULL;
 	}
 
+	/**
+	 * @param string $key
+	 * @param string $value
+	 */
 	public function as_array($key = NULL, $value = NULL)
 	{
 		$results = array();

classes/Kohana/Jam/Association.php

Doc Comments +3 added lines

@@ -72,6 +72,9 @@
 		return FALSE;
 	}
 
+	/**
+	 * @param string $type
+	 */
 	abstract public function join($table, $type = NULL);
 
 	public function set(Jam_Validated $model, $value, $is_changed)

classes/Kohana/Jam/Association/Belongsto.php

Doc Comments -1 removed lines

@@ -45,7 +45,6 @@
 	/**
 	 * Automatically sets foreign to sensible defaults.
 	 *
-	 * @param   string  $model
 	 * @param   string  $name
 	 * @return  void
 	 */

classes/Kohana/Jam/Association/Hasone.php

Doc Comments +9 added lines, -1 removed lines

@@ -31,7 +31,6 @@ 
 	/**
 	 * Automatically sets foreign to sensible defaults.
 	 *
-	 * @param   string  $model
 	 * @param   string  $name
 	 * @return  void
 	 */
@@ -147,6 +146,9 @@ 
 		return $this->set($model, $item, $is_changed);
 	}
 
+	/**
+	 * @param boolean $is_changed
+	 */
 	public function set(Jam_Validated $model, $value, $is_changed)
 	{
 		if ($value instanceof Jam_Model)
@@ -285,6 +287,9 @@ 
 		return (bool) $this->as;
 	}
 
+	/**
+	 * @param string $foreign_model
+	 */
 	protected function _find_item($foreign_model, $key)
 	{
 		if ( ! $key)
@@ -308,6 +313,9 @@ 
 		return $query->current();
 	}
 
+	/**
+	 * @param string $type
+	 */
 	public function query_builder($type, Jam_Model $model)
 	{
 		$query = call_user_func("Jam::{$type}", $this->foreign_model)

classes/Kohana/Jam/Attribute.php

Doc Comments +3 added lines, -2 removed lines

@@ -56,8 +56,6 @@ 
 	 * This is called after construction so that fields can finish
 	 * constructing themselves with a copy of the column it represents.
 	 *
-	 * @param   string  $model
-	 * @param   string  $column
 	 * @return  void
 	 **/
 	public function initialize(Jam_Meta $meta, $name)
@@ -80,6 +78,9 @@ 
 		$meta->events()->discover_events($this, Jam_Event::ATTRIBUTE_PRIORITY);
 	}
 
+	/**
+	 * @param boolean $is_changed
+	 */
 	abstract public function get(Jam_Validated $model, $value, $is_changed);
 
 	abstract public function set(Jam_Validated $model, $value, $is_changed);

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)