OpenBuildings / jam

classes/Kohana/Upload/File.php

Doc Comments +8 added lines, -1 removed lines

@@ -28,6 +28,10 @@ 
 	protected $_extracted_from_source = FALSE;
 
 
+	/**
+	 * @param string $server
+	 * @param string $path
+	 */
 	public function __construct($server, $path, $filename = NULL)
 	{
 		$this->server($server);
@@ -320,7 +324,6 @@ 
 	/**
 	 * Get the current url (temp or server)
 	 * @param  string $thumbnail
-	 * @param  mixed $protocol
 	 * @return string
 	 */
 	public function url($thumbnail = NULL)
@@ -346,6 +349,10 @@ 
 		return $this->temp()->directory().'/'.$this->filename();
 	}
 
+	/**
+	 * @param string $method
+	 * @param string $thumbnail
+	 */
 	protected function location($method, $thumbnail = NULL)
 	{
 		if ( ! $this->filename())

classes/Kohana/Upload/Temp.php

Doc Comments +6 added lines

@@ -14,6 +14,9 @@ 
 		return new Upload_Temp;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public static function config($name = NULL)
 	{
 		if ($name !== NULL)
@@ -33,6 +36,9 @@ 
 
 	protected $_directory;
 
+	/**
+	 * @param string $directory
+	 */
 	public function directory($directory = NULL)
 	{
 		if ($directory !== NULL)

classes/Kohana/Upload/Util.php

Doc Comments +5 added lines, -3 removed lines

@@ -11,6 +11,9 @@ 
 */
 class Kohana_Upload_Util {
 
+	/**
+	 * @param string $directory
+	 */
 	public static function download($url, $directory, $filename = NULL)
 	{
 		$url = str_replace(' ', '%20', $url);
@@ -63,8 +66,7 @@ 
 	 * Move the contents of the stream to a specified directory with a given name
 	 *
 	 * @param  string $stream
-	 * @param  string $directory
-	 * @param  string $filename
+	 * @param string $file
 	 */
 	public static function stream_copy_to_file($stream, $file)
 	{
@@ -146,7 +148,7 @@ 
 	 * Filenames can be in the query or the url of the file itself
 	 *
 	 * @param  string $url
-	 * @return array
+	 * @return string[]
 	 */
 	public static function filenames_candidates_from_url($url)
 	{

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 +6 added lines, -4 removed lines

@@ -260,6 +260,9 @@ 
 		return $this->_collection;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function validator($field, $options)
 	{
 		$fields = func_get_args();
@@ -402,7 +405,7 @@ 
 	 *
 	 * @param   string       $name     name of the field
 	 * @param   mixed        $field    the field alias or object
-	 * @return  Jam_Field|$this|null
+	 * @return  string
 	 */
 	public function field($name, $field = NULL, $prepend = FALSE)
 	{
@@ -628,7 +631,6 @@ 
 	 * Get / Set individual behaviors.
 	 *
 	 * @param   string       $name     name of the association
-	 * @param   mixed        $association    the association alias or object
 	 * @return  Jam_Behavior|$this|null
 	 */
 	public function behavior($name, $behavior = NULL, $prepend = FALSE)
@@ -676,7 +678,7 @@ 
 	 * Gets or sets the model's primary key.
 	 *
 	 * @param   string  $value
-	 * @return  mixed
+	 * @return  string
 	 */
 	public function primary_key($value = NULL)
 	{
@@ -692,7 +694,7 @@ 
 	 * Gets or sets the model's name key
 	 *
 	 * @param   string  $value
-	 * @return  string|$this
+	 * @return  string
 	 */
 	public function name_key($value = NULL)
 	{

classes/Kohana/Jam/Model.php

Doc Comments +3 added lines, -2 removed lines

@@ -39,7 +39,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)
 	{
@@ -190,7 +189,6 @@ 
 	 * Validates the current model's data
 	 *
 	 * @throws  Jam_Exception_Validation
-	 * @param   Validation|null   $extra_validation
 	 * @return  bool
 	 */
 	public function check($force = FALSE)
@@ -436,6 +434,9 @@ 
 		return $attribute;
 	}
 
+	/**
+	 * @param string $association_name
+	 */
 	public function build($association_name, array $attributes = array())
 	{
 		$association = $this->meta()->association($association_name);

classes/Kohana/Jam/Validated.php

Doc Comments -4 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,7 +319,6 @@ 
 	 * Validates the current model's data
 	 *
 	 * @throws  Jam_Exception_Validation
-	 * @param   Validation|null   $extra_validation
 	 * @return  bool
 	 */
 	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)

classes/Kohana/Jam.php

Doc Comments +8 added lines, -1 removed lines

@@ -379,7 +379,7 @@ 
 
 	/**
 	 * Make an object of class Jam_Query_Builder_Insert
-	 * @param  string|Jam_Model $model
+	 * @param  Kohana_Jam_Model $model
 	 * @return Jam_Query_Builder_Insert
 	 */
 	public static function insert($model, array $columns = array())
@@ -416,6 +416,10 @@ 
 		return new $class($model);
 	}
 
+	/**
+	 * @param string $method
+	 * @param string $model
+	 */
 	protected static function find_or($method, $model, array $values)
 	{
 		$collection = Jam::all($model);
@@ -517,6 +521,9 @@ 
 		return Jam_Validator_Attributes::factory($permit)->data($data)->clean();
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public static function form($model, $class = NULL)
 	{
 		if ($class === NULL)

classes/Kohana/Jam/Association/Manytomany.php

Doc Comments -1 removed lines

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