r95401 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r95400‎ | r95401 | r95402 >
Date:14:59, 24 August 2011
Author:salvatoreingala
Status:ok
Tags:
Comment:
Adding proper documentation to GadgetPrefs::isPrefsDescriptionValid().
Modified paths:
  • /branches/salvatoreingala/Gadgets/backend/GadgetPrefs.php (modified) (history)

Diff [purge]

Index: branches/salvatoreingala/Gadgets/backend/GadgetPrefs.php
@@ -605,7 +605,13 @@
606606 return true;
607607 }
608608
609 - //Checks if the given description of the preferences is valid
 609+ /**
 610+ * Checks validity of a preferences description.
 611+ *
 612+ * @param $prefsDescription Array: the preferences description to check.
 613+ *
 614+ * @return boolean true if $prefsDescription is a valid description of preferences, false otherwise.
 615+ */
610616 public static function isPrefsDescriptionValid( $prefsDescription ) {
611617 return self::validateSectionDefinition( $prefsDescription );
612618 }

Status & tagging log