From: Siebrand Mazeland <s.mazeland@xs4all.nl>
Date: Mon, 10 Dec 2012 10:53:03 +0000 (+0100)
Subject: Fix incorrect documentation for Language::getFormattedNsText()
X-Git-Tag: 1.31.0-rc.0~21350^2
X-Git-Url: http://git.cyclocoop.org/%7B%24admin_url%7Dmes_infos.php?a=commitdiff_plain;h=fc816895cbb082257dd30b48192af8631ffa8fa5;p=lhc%2Fweb%2Fwiklou.git

Fix incorrect documentation for Language::getFormattedNsText()

Change-Id: I16e9deaa5c962f177dee83785ac5142d4681b75f
---

diff --git a/languages/Language.php b/languages/Language.php
index a72f98f671..6f43b474bb 100644
--- a/languages/Language.php
+++ b/languages/Language.php
@@ -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 );