Fixed some @params documentation (includes/[specialpage|specials])

[lhc/web/wiklou.git] / includes / specials / SpecialVersion.php

diff --git a/includes/specials/SpecialVersion.php b/includes/specials/SpecialVersion.php
index 5c3f509..e61d17a 100644 (file)
--- a/includes/specials/SpecialVersion.php
+++ b/includes/specials/SpecialVersion.php
@@ -165,7 +165,7 @@ class SpecialVersion extends SpecialPage {
        /**
         * Get the "MediaWiki is copyright 2001-20xx by lots of cool guys" text
         *
-        * @return String
+        * @return string
         */
        public static function getCopyrightAndAuthorList() {
                global $wgLang;
@@ -240,7 +240,7 @@ class SpecialVersion extends SpecialPage {
        /**
         * Return a string of the MediaWiki version with SVN revision if available.
         *
-        * @param $flags String
+        * @param string $flags
         * @return mixed
         */
        public static function getVersion( $flags = '' ) {
@@ -409,7 +409,7 @@ class SpecialVersion extends SpecialPage {
         *
         * @since 1.17
         *
-        * @param $type String
+        * @param string $type
         *
         * @return string
         */
@@ -422,7 +422,7 @@ class SpecialVersion extends SpecialPage {
        /**
         * Generate wikitext showing extensions name, URL, author and description.
         *
-        * @return String: Wikitext
+        * @return string Wikitext
         */
        function getExtensionCredits() {
                global $wgExtensionCredits;
@@ -433,10 +433,7 @@ class SpecialVersion extends SpecialPage {
 
                $extensionTypes = self::getExtensionTypes();
 
-               /**
-                * @deprecated as of 1.17, use hook ExtensionTypes instead.
-                */
-               wfRunHooks( 'SpecialVersionExtensionTypes', array( &$this, &$extensionTypes ) );
+               wfRunHooks( 'SpecialVersionExtensionTypes', array( &$this, &$extensionTypes ), '1.17' );
 
                $out = Xml::element(
                                'h2',
@@ -533,8 +530,8 @@ class SpecialVersion extends SpecialPage {
         *
         * @since 1.17
         *
-        * @param $type String
-        * @param $message String
+        * @param string $type
+        * @param string $message
         *
         * @return string
         */
@@ -558,8 +555,8 @@ class SpecialVersion extends SpecialPage {
 
        /**
         * Callback to sort extensions by type.
-        * @param $a array
-        * @param $b array
+        * @param array $a
+        * @param array $b
         * @return int
         */
        function compare( $a, $b ) {
@@ -585,9 +582,9 @@ class SpecialVersion extends SpecialPage {
         *  - Description of extension (descriptionmsg or description)
         *  - List of authors (author) and link to a ((AUTHORS)|(CREDITS))(\.txt)? file if it exists
         *
-        * @param $extension Array
+        * @param array $extension
         *
-        * @return string raw HTML
+        * @return string Raw HTML
         */
        function getCreditsForExtension( array $extension ) {
                $out = $this->getOutput();
@@ -761,7 +758,7 @@ class SpecialVersion extends SpecialPage {
        /**
         * Generate wikitext showing hooks in $wgHooks.
         *
-        * @return String: wikitext
+        * @return string Wikitext
         */
        private function getWgHooks() {
                global $wgSpecialVersionShowHooks, $wgHooks;
@@ -832,7 +829,7 @@ class SpecialVersion extends SpecialPage {
        /**
         * Get information about client's IP address.
         *
-        * @return String: HTML fragment
+        * @return string HTML fragment
         */
        private function IPInfo() {
                $ip = str_replace( '--', ' - ', htmlspecialchars( $this->getRequest()->getIP() ) );
@@ -854,11 +851,11 @@ class SpecialVersion extends SpecialPage {
         *   If no '...' string variant is found, but an authors file is found an
         *   'and others' will be added to the end of the credits.
         *
-        * @param $authors mixed: string or array of strings
-        * @param $extName string: name of the extension for link creation
-        * @param $extDir  string: path to the extension root directory
+        * @param string|array $authors
+        * @param string $extName Name of the extension for link creation
+        * @param string $extDir Path to the extension root directory
         *
-        * @return String: HTML fragment
+        * @return string HTML fragment
         */
        function listAuthors( $authors, $extName, $extDir ) {
                $hasOthers = false;
@@ -958,36 +955,30 @@ class SpecialVersion extends SpecialPage {
        /**
         * Convert an array of items into a list for display.
         *
-        * @param array $list of elements to display
-        * @param $sort Boolean: whether to sort the items in $list
+        * @param array $list List of elements to display
+        * @param bool $sort Whether to sort the items in $list
         *
-        * @return String
+        * @return string
         */
        function listToText( $list, $sort = true ) {
-               $cnt = count( $list );
-
-               if ( $cnt == 1 ) {
-                       // Enforce always returning a string
-                       return (string)self::arrayToString( $list[0] );
-               } elseif ( $cnt == 0 ) {
+               if ( !count( $list ) ) {
                        return '';
-               } else {
-                       if ( $sort ) {
-                               sort( $list );
-                       }
-
-                       return $this->getLanguage()
-                               ->listToText( array_map( array( __CLASS__, 'arrayToString' ), $list ) );
                }
+               if ( $sort ) {
+                       sort( $list );
+               }
+
+               return $this->getLanguage()
+                       ->listToText( array_map( array( __CLASS__, 'arrayToString' ), $list ) );
        }
 
        /**
         * Convert an array or object to a string for display.
         *
-        * @param $list Mixed: will convert an array to string if given and return
-        *              the paramater unaltered otherwise
+        * @param mixed $list Will convert an array to string if given and return
+        *   the paramater unaltered otherwise
         *
-        * @return Mixed
+        * @return mixed
         */
        public static function arrayToString( $list ) {
                if ( is_array( $list ) && count( $list ) == 1 ) {
@@ -1023,7 +1014,7 @@ class SpecialVersion extends SpecialPage {
         *        url                   The subversion URL of the directory
         *        repo-url              The base URL of the repository
         *        viewvc-url            A ViewVC URL pointing to the checked-out revision
-        * @param $dir string
+        * @param string $dir
         * @return array|bool
         */
        public static function getSvnInfo( $dir ) {
@@ -1096,9 +1087,9 @@ class SpecialVersion extends SpecialPage {
        /**
         * Retrieve the revision number of a Subversion working directory.
         *
-        * @param string $dir directory of the svn checkout
+        * @param string $dir Directory of the svn checkout
         *
-        * @return Integer: revision number as int
+        * @return int Revision number
         */
        public static function getSvnRevision( $dir ) {
                $info = self::getSvnInfo( $dir );
@@ -1113,8 +1104,8 @@ class SpecialVersion extends SpecialPage {
        }
 
        /**
-        * @param string $dir directory of the git checkout
-        * @return bool|String sha1 of commit HEAD points to
+        * @param string $dir Directory of the git checkout
+        * @return bool|string Sha1 of commit HEAD points to
         */
        public static function getGitHeadSha1( $dir ) {
                $repo = new GitInfo( $dir );