Fix incorrect documentation for Language::getFormattedNsText()
authorSiebrand Mazeland <s.mazeland@xs4all.nl>
Mon, 10 Dec 2012 10:53:03 +0000 (11:53 +0100)
committerSiebrand Mazeland <s.mazeland@xs4all.nl>
Mon, 10 Dec 2012 10:53:03 +0000 (11:53 +0100)
Change-Id: I16e9deaa5c962f177dee83785ac5142d4681b75f

languages/Language.php

index a72f98f..6f43b47 100644 (file)
@@ -468,9 +468,13 @@ class Language {
         * getNsText() except with '_' changed to ' ', useful for
         * producing output.
         *
-        * @param $index string
+        * <code>
+        * $mw_ns = $wgContLang->getFormattedNsText( NS_MEDIAWIKI_TALK );
+        * echo $mw_ns; // prints 'MediaWiki talk'
+        * </code>
         *
-        * @return array
+        * @param int $index The array key of the namespace to return
+        * @return string Namespace name without underscores (empty string if namespace does not exist)
         */
        function getFormattedNsText( $index ) {
                $ns = $this->getNsText( $index );