Merge "PrefixSearch: Remove unnecessary wfSuppressWarnings()"
[lhc/web/wiklou.git] / includes / Skin.php
index 6722cca..e6abdfb 100644 (file)
@@ -92,9 +92,9 @@ abstract class Skin extends ContextSource {
         * Fetch the list of user-selectable skins in regards to $wgSkipSkins.
         * Useful for Special:Preferences and other places where you
         * only want to show skins users _can_ use.
-        * @return array of strings
+        * @return string[]
         */
-       public static function getUsableSkins() {
+       public static function getAllowedSkins() {
                global $wgSkipSkins;
 
                $allowedSkins = self::getSkinNames();
@@ -106,6 +106,15 @@ abstract class Skin extends ContextSource {
                return $allowedSkins;
        }
 
+       /**
+        * @deprecated since 1.23, use getAllowedSkins
+        * @return string[]
+        */
+       public static function getUsableSkins() {
+               wfDeprecated( __METHOD__, '1.23' );
+               return self::getAllowedSkins();
+       }
+
        /**
         * Normalize a skin preference value to a form that can be loaded.
         * If a skin can't be found, it will fall back to the configured
@@ -182,7 +191,9 @@ abstract class Skin extends ContextSource {
                return $skin;
        }
 
-       /** @return string skin name */
+       /**
+        * @return string skin name
+        */
        public function getSkinName() {
                return $this->skinname;
        }
@@ -958,9 +969,10 @@ abstract class Skin extends ContextSource {
        }
 
        /**
-        * @param $desc
-        * @param $page
-        * @return string
+        * Returns an HTML link for use in the footer
+        * @param string $desc i18n message key for the link text
+        * @param string $page i18n message key for the page to link to
+        * @return string HTML anchor
         */
        public function footerLink( $desc, $page ) {
                // if the link description has been set to "-" in the default language,
@@ -1247,6 +1259,7 @@ abstract class Skin extends ContextSource {
                wfProfileOut( __METHOD__ );
                return $bar;
        }
+
        /**
         * Add content from a sidebar system message
         * Currently only used for MediaWiki:Sidebar (but may be used by Extensions)
@@ -1569,14 +1582,14 @@ abstract class Skin extends ContextSource {
         * Create a section edit link.  This supersedes editSectionLink() and
         * editSectionLinkForOther().
         *
-        * @param $nt      Title  The title being linked to (may not be the same as
+        * @param $nt Title  The title being linked to (may not be the same as
         *   the current page, if the section is included from a template)
         * @param string $section The designation of the section being pointed to,
         *   to be included in the link, like "&section=$section"
         * @param string $tooltip The tooltip to use for the link: will be escaped
         *   and wrapped in the 'editsectionhint' message
-        * @param $lang    string Language code
-        * @return         string HTML to use for edit link
+        * @param $lang string Language code
+        * @return string HTML to use for edit link
         */
        public function doEditSectionLink( Title $nt, $section, $tooltip = null, $lang = false ) {
                // HTML generated here should probably have userlangattributes