1.5.0 release

README.md

@@ -172,7 +172,7 @@ The requires fields currently are: name and message
 				<li>minlength: int or false</li>
 				<li>maxlength: int or false</li>
 				<li>regex: string</li>
-			<ul>
+			</ul>
 		</td>
 	</tr>
 	<tr>
@@ -190,7 +190,7 @@ The requires fields currently are: name and message
 				<li>upperbound: int, float or false</li>
 				<li>range: [lowerbound, upperbound]</li>
 				<li>withinrange: [float $point, float $deviation]</li>
-			<ul>
+			</ul>
 		</td>
 	</tr>
 	<tr>
@@ -214,7 +214,7 @@ The requires fields currently are: name and message
 				<li>defaultunit: string</li>
 				<li>lowerbound: int, float or false</li>
 				<li>upperbound: int, float or false</li>
-			<ul>
+			</ul>
 		</td>
 	</tr>
 </table>
@@ -303,6 +303,10 @@ support the [Maps](https://github.com/JeroenDeDauw/Maps) and
 
 ## Release notes
 
+### 1.5.0 (2019-07-28)
+
+* Improved code comments
+
 ### 1.4.2 (2018-11-26)
 
 * Fixed defaulting behaviour of list parameters

composer.json

@@ -49,7 +49,7 @@
 	},
 	"extra": {
 		"branch-alias": {
-			"dev-master": "1.4.x-dev"
+			"dev-master": "1.5.x-dev"
 		}
 	},
 	"scripts": {

src/IParamDefinition.php

@@ -53,7 +53,7 @@ public function format( IParam $param, array &$definitions, array $params );
 	 *
 	 * @return string[]
 	 */
-	public function getAliases();
+	public function getAliases(): array;
 
 	/**
 	 * Returns the default value.
@@ -72,7 +72,7 @@ public function getDefault();
 	 *
 	 * @return string
 	 */
-	public function getDelimiter();
+	public function getDelimiter(): string;
 
 	/**
 	 * Returns a list of dependencies the parameter has, in the form of
@@ -82,7 +82,7 @@ public function getDelimiter();
 	 *
 	 * @return string[]
 	 */
-	public function getDependencies();
+	public function getDependencies(): array;
 
 	/**
 	 * Returns a message that will act as a description message for the parameter.
@@ -91,7 +91,7 @@ public function getDependencies();
 	 *
 	 * @return string
 	 */
-	public function getMessage();
+	public function getMessage(): string;
 
 	/**
 	 * Returns the parameters main name.
@@ -100,7 +100,7 @@ public function getMessage();
 	 *
 	 * @return string
 	 */
-	public function getName();
+	public function getName(): string;
 
 	/**
 	 * Returns an identifier for the type of the parameter.
@@ -109,7 +109,7 @@ public function getName();
 	 *
 	 * @return string
 	 */
-	public function getType();
+	public function getType(): string;
 
 	/**
 	 * Returns if the parameter has a certain alias.
@@ -120,7 +120,7 @@ public function getType();
 	 *
 	 * @return boolean
 	 */
-	public function hasAlias( $alias );
+	public function hasAlias( string $alias ): bool;
 
 	/**
 	 * Returns if the parameter has a certain dependency.
@@ -131,7 +131,7 @@ public function hasAlias( $alias );
 	 *
 	 * @return boolean
 	 */
-	public function hasDependency( $dependency );
+	public function hasDependency( string $dependency ): bool;
 
 	/**
 	 * Returns if the parameter is a list or not.
@@ -140,7 +140,7 @@ public function hasDependency( $dependency );
 	 *
 	 * @return boolean
 	 */
-	public function isList();
+	public function isList(): bool;
 
 	/**
 	 * Returns if the parameter is a required one or not.
@@ -149,7 +149,7 @@ public function isList();
 	 *
 	 * @return boolean
 	 */
-	public function isRequired();
+	public function isRequired(): bool;
 
 	/**
 	 * Sets the default parameter value. Null indicates no default,
@@ -179,19 +179,17 @@ public function setDelimiter( $delimiter );
 	 *
 	 * @param boolean $manipulateDefault
 	 */
-	public function setDoManipulationOfDefault( $manipulateDefault );
+	public function setDoManipulationOfDefault( bool $manipulateDefault );
 
 	/**
 	 * Sets a message for the parameter that will act as description.
-	 * This should be a message key, ie something that can be passed
-	 * to wfMsg. Not an actual text. If you do not have a message key,
-	 * but only a text, use setDescription instead.
+	 *
 	 *
 	 * @since 1.0
 	 *
 	 * @param string $message
 	 */
-	public function setMessage( $message );
+	public function setMessage( string $message );
 
 	/**
 	 * Returns if the parameter manipulations should be applied to the default value.
@@ -200,7 +198,7 @@ public function setMessage( $message );
 	 *
 	 * @return boolean
 	 */
-	public function shouldManipulateDefault();
+	public function shouldManipulateDefault(): bool;
 
 	/**
 	 * Returns a message key for a message describing the parameter type.
@@ -209,11 +207,10 @@ public function shouldManipulateDefault();
 	 *
 	 * @return string
 	 */
-	public function getTypeMessage();
+	public function getTypeMessage(): string;
 
 	/**
 	 * Returns if the value should be trimmed before validation and any further processing.
-	 * @see IParamDefinition::trimDuringClean
 	 *
 	 * @since 1.0
 	 *
@@ -267,7 +264,7 @@ public function setValueValidator( ValueValidator $validator );
 	 *
 	 * @param callable $validationFunction
 	 */
-	public function setValidationCallback( /* callable */ $validationFunction );
+	public function setValidationCallback( callable $validationFunction );
 
 	/**
 	 * Sets the parameter definition values contained in the provided array.