OpenBuildings / jam

classes/Kohana/Jam/Association/Hasmany.php

Doc Comments +6 added lines, -3 removed lines

@@ -48,7 +48,6 @@ 
 	/**
 	 * Initialize foreign_key, as, and polymorphic_key with default values
 	 *
-	 * @param   string  $model
 	 * @param   string  $name
 	 */
 	public function initialize(Jam_Meta $meta, $name)
@@ -174,7 +173,7 @@ 
 	/**
 	 * Generate a query to delete associated models in the database
 	 * @param  Jam_Model $model
-	 * @return Database_Query
+	 * @return null|Jam_Query_Builder_Delete
 	 */
 	public function erase_query(Jam_Model $model)
 	{
@@ -197,7 +196,7 @@ 
 	/**
 	 * Generate a query to remove models from this association (without deleting them)
 	 * @param  Jam_Model $model
-	 * @return Database_Query
+	 * @return null|Jam_Query_Builder_Update
 	 */
 	public function nullify_query(Jam_Model $model)
 	{
@@ -280,6 +279,10 @@ 
 	}
 
 
+	/**
+	 * @param string|null $polymorphic_key
+	 * @param Jam_Validated|null $inverse_of
+	 */
 	protected function assign_item(Jam_Model $item, $foreign_key, $polymorphic_key, $inverse_of)
 	{
 		$item->{$this->foreign_key} = $foreign_key;

classes/Kohana/Jam/Meta.php

Doc Comments +5 added lines, -3 removed lines

@@ -261,6 +261,9 @@ 
 		return $this->_collection;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function validator($field, $options)
 	{
 		$fields = func_get_args();
@@ -403,7 +406,7 @@ 
 	 *
 	 * @param   string       $name     name of the field
 	 * @param   mixed        $field    the field alias or object
-	 * @return  Jam_Field|Jam_Meta|null
+	 * @return  string
 	 */
 	public function field($name, $field = NULL, $prepend = FALSE)
 	{
@@ -629,7 +632,6 @@ 
 	 * Get / Set individual behaviors.
 	 *
 	 * @param   string       $name     name of the association
-	 * @param   mixed        $association    the association alias or object
 	 * @return  Jam_Association|Jam_Meta|null
 	 */
 	public function behavior($name, $behavior = NULL, $prepend = FALSE)
@@ -677,7 +679,7 @@ 
 	 * Gets or sets the model's primary key.
 	 *
 	 * @param   string  $value
-	 * @return  mixed
+	 * @return  string
 	 */
 	public function primary_key($value = NULL)
 	{

classes/Kohana/Jam/Validated.php

Doc Comments +1 added lines, -5 removed lines

@@ -54,7 +54,6 @@ 
 	 * A key can be passed to automatically load a model by its
 	 * unique key.
 	 *
-	 * @param  mixed|null  $key
 	 */
 	public function __construct($meta_name = NULL)
 	{
@@ -204,7 +203,6 @@ 
 	 * This method—combined with get(), which first searches for changed
 	 * values—is useful for comparing changes that occurred on a model.
 	 *
-	 * @param   string  $field The field's or alias name
 	 * @return  mixed
 	 */
 	public function original($field_name = NULL)
@@ -321,8 +319,7 @@ 
 	 * Validates the current model's data
 	 *
 	 * @throws  Jam_Exception_Validation
-	 * @param   Validation|null   $extra_validation
-	 * @return  Kohana_Jam_Model
+	 * @return  boolean
 	 */
 	public function check($force = FALSE)
 	{
@@ -437,7 +434,6 @@ 
 	 * If $field is NULL, the method returns whether or not any
 	 * data whatsoever was changed on the model.
 	 *
-	 * @param   string   $field
 	 * @return  boolean
 	 */
 	public function changed($name = NULL)