Add missing type to @param documentation

[lhc/web/wiklou.git] / includes / specialpage / AuthManagerSpecialPage.php

diff --git a/includes/specialpage/AuthManagerSpecialPage.php b/includes/specialpage/AuthManagerSpecialPage.php
index 3adf5a6..500c2e9 100644 (file)
--- a/includes/specialpage/AuthManagerSpecialPage.php
+++ b/includes/specialpage/AuthManagerSpecialPage.php
@@ -43,9 +43,9 @@ abstract class AuthManagerSpecialPage extends SpecialPage {
         * Change the form descriptor that determines how a field will look in the authentication form.
         * Called from fieldInfoToFormDescriptor().
         * @param AuthenticationRequest[] $requests
-        * @param string $fieldInfo Field information array (union of all
+        * @param array $fieldInfo Field information array (union of all
         *    AuthenticationRequest::getFieldInfo() responses).
-        * @param array $formDescriptor HTMLForm descriptor. The special key 'weight' can be set to
+        * @param array &$formDescriptor HTMLForm descriptor. The special key 'weight' can be set to
         *    change the order of the fields.
         * @param string $action Authentication type (one of the AuthManager::ACTION_* constants)
         * @return bool
@@ -198,13 +198,12 @@ abstract class AuthManagerSpecialPage extends SpecialPage {
         * @param string $subPage Subpage of the special page.
         * @return string an AuthManager::ACTION_* constant.
         */
-       protected function getDefaultAction( $subPage ) {
-               throw new BadMethodCallException( 'Subclass did not implement getDefaultAction' );
-       }
+       abstract protected function getDefaultAction( $subPage );
 
        /**
         * Return custom message key.
         * Allows subclasses to customize messages.
+        * @param string $defaultKey
         * @return string
         */
        protected function messageKey( $defaultKey ) {
@@ -475,7 +474,7 @@ abstract class AuthManagerSpecialPage extends SpecialPage {
        /**
         * Submit handler callback for HTMLForm
         * @private
-        * @param $data array Submitted data
+        * @param array $data Submitted data
         * @return Status
         */
        public function handleFormSubmit( $data ) {
@@ -599,7 +598,7 @@ abstract class AuthManagerSpecialPage extends SpecialPage {
        /**
         * Adds a sequential tabindex starting from 1 to all form elements. This way the user can
         * use the tab key to traverse the form without having to step through all links and such.
-        * @param $formDescriptor
+        * @param array &$formDescriptor
         */
        protected function addTabIndex( &$formDescriptor ) {
                $i = 1;
@@ -668,6 +667,7 @@ abstract class AuthManagerSpecialPage extends SpecialPage {
         * Maps an authentication field configuration for a single field (as returned by
         * AuthenticationRequest::getFieldInfo()) to a HTMLForm field descriptor.
         * @param array $singleFieldInfo
+        * @param string $fieldName
         * @return array
         */
        protected static function mapSingleFieldInfo( $singleFieldInfo, $fieldName ) {
@@ -709,7 +709,7 @@ abstract class AuthManagerSpecialPage extends SpecialPage {
         * Sort the fields of a form descriptor by their 'weight' property. (Fields with higher weight
         * are shown closer to the bottom; weight defaults to 0. Negative weight is allowed.)
         * Keep order if weights are equal.
-        * @param array $formDescriptor
+        * @param array &$formDescriptor
         * @return array
         */
        protected static function sortFormDescriptorFields( array &$formDescriptor ) {