Standardize Doxygen @param tags

Use "@param datatype $paramname description" format.

Change-Id: If52c7f971575584028f5192a1fa87b0fda434ff0

client/WikibaseClient.hooks.php

@@ -347,7 +347,7 @@ public static function onGetPreferences( User $user, array &$prefs ) {
 	/**
 	 * Register the parser functions.
 	 *
-	 * @param $parser Parser
+	 * @param Parser $parser
 	 *
 	 * @return bool
 	 */

lib/includes/LanguageWithConversion.php

@@ -240,7 +240,7 @@ public function translate( $text ) {
 	 *
 	 * Does nothing if this is not a converted language.
 	 *
-	 * @param $text String
+	 * @param string $text
 	 */
 	private function prepareForTranslate( $text ) {
 		if ( $this->parentLanguage ) {

repo/Wikibase.hooks.php

@@ -303,7 +303,7 @@ public static function onArticleUndelete( Title $title, $created, $comment ) {
 	 *
 	 * @todo: find a better way to do this!
 	 *
-	 * @param $recentChange RecentChange
+	 * @param RecentChange $recentChange
 	 * @return bool
 	 */
 	public static function onRecentChangeSave( RecentChange $recentChange ) {

repo/includes/Actions/EditEntityAction.php

@@ -434,8 +434,8 @@ private function showDiffStyle() {
 	/**
 	 * Generate standard summary input and label (wgSummary), compatible to EditPage.
 	 *
-	 * @param $summary string The value of the summary input
-	 * @param $labelText string The html to place inside the label
+	 * @param string $summary The value of the summary input
+	 * @param string $labelText The html to place inside the label
 	 *
 	 * @return array An array in the format array( $label, $input )
 	 */

repo/includes/Api/ApiErrorReporter.php

@@ -340,7 +340,7 @@ public function addStatusToResult( Status $status, &$data ) {
 	 * This provides support for message lists coming from Status::getErrorsByType() as well as
 	 * Title::getUserPermissionsErrors() etc.
 	 *
-	 * @param $messageSpecs array a list of errors, as returned by Status::getErrorsByType()
+	 * @param array $messageSpecs a list of errors, as returned by Status::getErrorsByType()
 	 *        or Title::getUserPermissionsErrors()
 	 *
 	 * @return array a result structure containing the messages from $errors as well as what
@@ -383,7 +383,7 @@ private function convertMessagesToResult( array $messageSpecs ) {
 	 *
 	 * @see convertToMessage()
 	 *
-	 * @param $messageSpecs array a list of errors, as returned by Status::getErrorsByType()
+	 * @param array $messageSpecs a list of errors, as returned by Status::getErrorsByType()
 	 *        or Title::getUserPermissionsErrors().
 	 *
 	 * @return array a result structure containing the messages from $errors as well as what

repo/includes/Api/ModifyEntity.php

@@ -464,8 +464,8 @@ public function execute() {
 	/**
 	 * Check the rights for the user accessing the module.
 	 *
-	 * @param $entity EntityDocument the entity to check
-	 * @param $user User doing the action
+	 * @param EntityDocument $entity the entity to check
+	 * @param User $user User doing the action
 	 *
 	 * @return Status the check's result
 	 */

repo/includes/Api/ResultBuilder.php

@@ -118,7 +118,7 @@ public function __construct(
 	/**
 	 * @since 0.5
 	 *
-	 * @param $success bool|int|null
+	 * @param bool|int|null $success
 	 */
 	public function markSuccess( $success = true ) {
 		$value = (int)$success;
@@ -145,9 +145,9 @@ public function markSuccess( $success = true ) {
 	 *
 	 * @since 0.5
 	 *
-	 * @param $path array|string|null
-	 * @param $name string
-	 * @param $values array
+	 * @param array|string|null $path
+	 * @param string $name
+	 * @param array $values
 	 * @param string $tag tag name to use for elements of $values if not already present
 	 */
 	public function setList( $path, $name, array $values, $tag ) {
@@ -178,9 +178,9 @@ public function setList( $path, $name, array $values, $tag ) {
 	 *
 	 * @since 0.5
 	 *
-	 * @param $path array|string|null
-	 * @param $name string
-	 * @param $value mixed
+	 * @param array|string|null $path
+	 * @param string $name
+	 * @param mixed $value
 	 */
 	public function setValue( $path, $name, $value ) {
 		$this->checkPathType( $path );
@@ -204,10 +204,10 @@ public function setValue( $path, $name, $value ) {
 	 *
 	 * @since 0.5
 	 *
-	 * @param $path array|string|null
-	 * @param $key int|string|null the key to use when appending, or null for automatic.
+	 * @param array|string|null $path
+	 * @param int|string|null $key the key to use when appending, or null for automatic.
 	 * May be ignored even if given, based on $this->addMetaData.
-	 * @param $value mixed
+	 * @param mixed $value
 	 * @param string $tag tag name to use for $value in indexed mode
 	 */
 	public function appendValue( $path, $key, $value, $tag ) {
@@ -234,7 +234,7 @@ private function checkPathType( $path ) {
 	}
 
 	/**
-	 * @param $key int|string|null the key to use when appending, or null for automatic.
+	 * @param int|string|null $key the key to use when appending, or null for automatic.
 	 */
 	private function checkKeyType( $key ) {
 		Assert::parameter(

repo/includes/Content/EntityHandler.php

@@ -556,9 +556,9 @@ public function getSpecialPageForCreation() {
 	 *
 	 * @since 0.4
 	 *
-	 * @param $latestRevision Revision The current text
-	 * @param $newerRevision Revision The revision to undo
-	 * @param $olderRevision Revision Must be an earlier revision than $undo
+	 * @param Revision $latestRevision The current text
+	 * @param Revision $newerRevision The revision to undo
+	 * @param Revision $olderRevision Must be an earlier revision than $undo
 	 *
 	 * @return Content|bool Content on success, false on failure
 	 */

repo/includes/Diff/EntityContentDiffView.php

@@ -127,7 +127,7 @@ public function getDiffLang() {
 	/**
 	 * Get a header for a specified revision.
 	 *
-	 * @param $rev Revision
+	 * @param Revision $rev
 	 * @param string $complete 'complete' to get the header wrapped depending
 	 *        the visibility of the revision and a link to edit the page.
 	 *

repo/includes/Specials/SpecialSetSiteLink.php

@@ -194,7 +194,7 @@ protected function modifyEntity( EntityDocument $entity ) {
 	/**
 	 * Checks if the site id is valid.
 	 *
-	 * @param $siteId string the site id
+	 * @param string $siteId the site id
 	 *
 	 * @return bool
 	 */

repo/tests/phpunit/includes/Api/EntityTestHelper.php

@@ -392,7 +392,7 @@ public static function getId( $handle ) {
 	}
 
 	/**
-	 * @param $id string of entityid
+	 * @param string $id string of entityid
 	 * @return null|string id of current handle (if active)
 	 */
 	public static function getHandle( $id ) {

repo/tests/phpunit/includes/Api/IndependentWikibaseApiTestCase.php

@@ -66,8 +66,8 @@ public function doApiRequest( array $params ) {
 	 * @since 0.5
 	 *
 	 * Do the test for exceptions from Api queries.
-	 * @param $params array of params for the api query
-	 * @param $exception array details of the exception to expect (type,code,message)
+	 * @param array $params array of params for the api query
+	 * @param array $exception details of the exception to expect (type,code,message)
 	 */
 	public function doTestQueryExceptions( $params, $exception ) {
 		try {

view/src/EntityTermsView.php

@@ -163,7 +163,7 @@ private function getHtmlForAliases( $languageCode, AliasGroupList $aliasGroups )
 	}
 
 	/**
-	 * @param $languageCode The language for which terms should be edited
+	 * @param string $languageCode The language for which terms should be edited
 	 * @param EntityId|null $entityId
 	 *
 	 * @return string HTML

view/src/Template/TemplateFactory.php

@@ -63,7 +63,7 @@ public function get( $key, array $params ) {
 	 *
 	 * @since 0.2
 	 *
-	 * @param $key string template key
+	 * @param string $key template key
 	 * Varargs: normal template parameters
 	 *
 	 * @return string