ProjectCleverWeb / PHP-Color

src/generate.php

Doc Comments +6 added lines, -6 removed lines

@@ -72,12 +72,12 @@
 	/**
 	 * Generate a random HSL color
 	 * 
-	 * @param  int $min_r The min hue to allow
-	 * @param  int $max_r The max hue to allow
-	 * @param  int $min_g The min saturation to allow
-	 * @param  int $max_g The max saturation to allow
-	 * @param  int $min_b The min light to allow
-	 * @param  int $max_b The max light to allow
+	 * @param  int $min_h The min hue to allow
+	 * @param  int $max_h The max hue to allow
+	 * @param  int $min_h The min saturation to allow
+	 * @param  int $max_h The max saturation to allow
+	 * @param  int $min_h The min light to allow
+	 * @param  int $max_h The max light to allow
 	 * @return array      The resulting color as a HSL array
 	 */
 	public static function hsl_rand(int $min_h = 0, int $max_h = 359, int $min_s = 0, int $max_s = 100, int $min_l = 0, int $max_l = 100) :array {

src/hsl.php

Doc Comments +2 added lines, -2 removed lines

@@ -78,7 +78,7 @@ 
 	 * 
 	 * @param  string $offset The offset to set
 	 * @param  mixed  $value  The value to set it to
-	 * @return mixed          The result
+	 * @return double|null          The result
 	 */
 	public function offsetSet($offset, $value) {
 		if ($this->offsetExists($offset)) {
@@ -95,7 +95,7 @@ 
 	 * Reset an offset to 0
 	 * 
 	 * @param  string $offset The offset to unset
-	 * @return mixed          The result
+	 * @return double|null          The result
 	 */
 	public function offsetUnset($offset) {
 		if ($this->offsetExists($offset)) {

src/main_peripheral.php

Doc Comments +3 added lines

@@ -51,6 +51,9 @@
 		return $this->color->jsonSerialize();
 	}
 	
+	/**
+	 * @param scheme $scheme_class
+	 */
 	protected function get_scheme(string $scheme_name, string $return_type = 'hex', $scheme_class) :array {
 		if (!is_null($cached = $this->cache->get(get_class($scheme_class).'_'.$scheme_name.'_'.$return_type, $this->hex()))) {
 			return $cached;

src/scheme.php

Doc Comments +1 added lines

@@ -333,6 +333,7 @@
 	 * @param  float $h The hue degree (0 - 359)
 	 * @param  float $s The saturation percentage (0 - 100)
 	 * @param  float $l The lighting percentage (0 - 100)
+	 * @param boolean|null $is_dark
 	 * @return void
 	 */
 	protected static function is_dark(&$is_dark, float $h = 0.0, float $s = 0.0, float $l = 0.0) {

src/regulate.php

Doc Comments +1 added lines, -1 removed lines

@@ -181,7 +181,7 @@
 	 * '000000'
 	 * 
 	 * @param  string &$hex_str The hex string to modify
-	 * @return void
+	 * @return boolean
 	 */
 	public static function _validate_hex_str(string &$hex_str, bool $check_only = FALSE) :bool {
 		if (preg_match('/\A#?(?:[0-9a-f]{3}|[0-9a-f]{6})\Z/i', $hex_str)) {

src/data/color_space.php

Doc Comments +2 added lines, -2 removed lines

@@ -71,7 +71,7 @@ 
 	/**
 	 * Import a value according to its specification
 	 * 
-	 * @param  array  $value The value to import
+	 * @param  double  $value The value to import
 	 * @param  string $key   The key being imported
 	 * @param  array  $spec  The specification to follow
 	 * @return void
@@ -319,7 +319,7 @@ 
 	/**
 	 * DISABLED
 	 * 
-	 * @param  mixed $disabled Disabled
+	 * @param  mixed $disbaled Disabled
 	 * @return void
 	 * @codeCoverageIgnore
 	 */

src/error.php

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 	 * Triggers a E_USER_WARNING error with $message
 	 * 
 	 * @param  string $message The message describing the error
-	 * @return void
+	 * @return boolean
 	 */
 	protected static function standard(string $message, int $code = 0) {
 		if (!isset(static::$type_map[$code])) {

src/traits/converter.php

Doc Comments +9 added lines

@@ -14,10 +14,16 @@ 
  */
 trait converter {
 	
+	/**
+	 * @param string $message
+	 */
 	protected static function error($message) {
 		return \projectcleverweb\color\error::trigger(0, $message);
 	}
 	
+	/**
+	 * @return double
+	 */
 	protected static function _validate_array_input($input) {
 		if (!is_array($input)) {
 			static::error(sprintf(
@@ -43,6 +49,9 @@ 
 		return $array;
 	}
 	
+	/**
+	 * @return string
+	 */
 	public static function _validate_hex_input($input) {
 		if (is_int($input)) {
 			return str_pad(dechex($input % 16777216), 6, '0', STR_PAD_LEFT);