r71358 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r71357‎ | r71358 | r71359 >
Date:14:38, 20 August 2010
Author:siebrand
Status:deferred
Tags:
Comment:
Documentation update.
Modified paths:
  • /trunk/extensions/Translate/SpecialTranslationChanges.php (modified) (history)
  • /trunk/extensions/Translate/tag/SpecialPageTranslationMovePage.php (modified) (history)

Diff [purge]

Index: trunk/extensions/Translate/tag/SpecialPageTranslationMovePage.php
@@ -1,4 +1,14 @@
22 <?php
 3+/**
 4+ * Overrides Special:Movepage to to allow renaming a page translation page and
 5+ * all related translations and derivative pages.
 6+ *
 7+ * @ingroup SpecialPage
 8+ * @ingroup PageTranslation
 9+ * @author Niklas Laxström
 10+ * @copyright Copyright © 2010, Niklas Laxström
 11+ * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
 12+ */
313
414 class SpecialPageTranslationMovePage extends UnlistedSpecialPage {
515 // Basif form parameters both as text and as titles
@@ -203,7 +213,7 @@
204214
205215 /**
206216 * Shortcut for keeping the code at least a bit readable. Adds label and input into $form array.
207 - * @params Many
 217+ * @todo Document parameters.
208218 */
209219 protected function addInputLabel( &$form, $label, $name, $size = false , $text = false, $attribs = array() ) {
210220 $br = Html::element( 'br' );
Index: trunk/extensions/Translate/SpecialTranslationChanges.php
@@ -1,10 +1,12 @@
22 <?php
33 /**
4 - * Implementation of Special:TranslationChanges special page.
 4+ * Implementation of Special:TranslationChanges special page. Gives an overview
 5+ * per message group of translations in a given number of hours.
56 *
6 - * @file
 7+ * @ingroup SpecialPage
78 * @author Niklas Laxström
8 - * @copyright Copyright © 2008-2010, Niklas Laxström
 9+ * @author Siebrand Mazeland
 10+ * @copyright Copyright © 2008-2010, Niklas Laxström, Siebrand Mazeland
911 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
1012 */
1113
@@ -224,12 +226,11 @@
225227
226228 /**
227229 * Generate HTML for an arrow or placeholder graphic
228 - * @param string $dir one of '', 'd', 'l', 'r'
229 - * @param string $alt text
230 - * @return string HTML <img> tag
231 - * @access private
 230+ * @param $dir \string One of '', 'd', 'l', 'r'
 231+ * @param $alt \string Alt text
 232+ * @return string HTML "img" tag
232233 */
233 - function arrow( $dir, $alt = '' ) {
 234+ private function arrow( $dir, $alt = '' ) {
234235 global $wgStylePath;
235236 $encUrl = htmlspecialchars( $wgStylePath . '/common/images/Arr_' . $dir . '.png' );
236237 $encAlt = htmlspecialchars( $alt );
@@ -239,10 +240,9 @@
240241 /**
241242 * Generate HTML for a right- or left-facing arrow,
242243 * depending on language direction.
243 - * @return string HTML <img> tag
244 - * @access private
 244+ * @return string HTML "img" tag
245245 */
246 - function sideArrow() {
 246+ private function sideArrow() {
247247 global $wgContLang;
248248 $dir = $wgContLang->isRTL() ? 'l' : 'r';
249249 return $this->arrow( $dir, '+' );
@@ -252,9 +252,8 @@
253253 * Generate HTML for a down-facing arrow
254254 * depending on language direction.
255255 * @return string HTML <img> tag
256 - * @access private
257256 */
258 - function downArrow() {
 257+ private function downArrow() {
259258 return $this->arrow( 'd', '-' );
260259 }
261260 }

Status & tagging log