From: jeroendedauw Date: Mon, 27 Aug 2012 20:22:17 +0000 (+0200) Subject: Added missing @since tags to all methods X-Git-Tag: 1.31.0-rc.0~22579^2 X-Git-Url: http://git.cyclocoop.org/%7B%24www_url%7Dadmin/membres/fiche.php?a=commitdiff_plain;h=b26a67a76e19f9a18c081a16b2d47599452cf9fa;p=lhc%2Fweb%2Fwiklou.git Added missing @since tags to all methods except for numParams, as Siebrand already did this in another commit Change-Id: Ie3317af53c1df1eea99a77f402c6f7f1748dce1a --- diff --git a/includes/Message.php b/includes/Message.php index f559d304b4..68eb65016c 100644 --- a/includes/Message.php +++ b/includes/Message.php @@ -209,6 +209,7 @@ class Message { /** * Constructor. + * @since 1.17 * @param $key: message key, or array of message keys to try and use the first non-empty message for * @param $params Array message parameters * @return Message: $this @@ -224,6 +225,7 @@ class Message { * Factory function that is just wrapper for the real constructor. It is * intented to be used instead of the real constructor, because it allows * chaining method calls, while new objects don't. + * @since 1.17 * @param $key String: message key * @param Varargs: parameters as Strings * @return Message: $this @@ -238,6 +240,7 @@ class Message { * Factory function accepting multiple message keys and returning a message instance * for the first message which is non-empty. If all messages are empty then an * instance of the first message key is returned. + * @since 1.18 * @param Varargs: message keys (or first arg as an array of all the message keys) * @return Message: $this */ @@ -257,6 +260,7 @@ class Message { /** * Adds parameters to the parameter list of this message. + * @since 1.17 * @param Varargs: parameters as Strings, or a single argument that is an array of Strings * @return Message: $this */ @@ -275,6 +279,7 @@ class Message { * In other words the parsing process cannot access the contents * of this type of parameter, and you need to make sure it is * sanitized beforehand. The parser will see "$n", instead. + * @since 1.17 * @param Varargs: raw parameters as Strings (or single argument that is an array of raw parameters) * @return Message: $this */ @@ -308,7 +313,7 @@ class Message { /** * Set the language and the title from a context object - * + * @since 1.19 * @param $context IContextSource * @return Message: $this */ @@ -378,6 +383,7 @@ class Message { /** * Enable or disable database use. + * @since 1.17 * @param $value Boolean * @return Message: $this */ @@ -388,7 +394,7 @@ class Message { /** * Set the Title object to use as context when transforming the message - * + * @since 1.18 * @param $title Title object * @return Message: $this */ @@ -399,6 +405,7 @@ class Message { /** * Returns the message parsed from wikitext to HTML. + * @since 1.17 * @return String: HTML */ public function toString() { @@ -441,6 +448,7 @@ class Message { * Magic method implementation of the above (for PHP >= 5.2.0), so we can do, eg: * $foo = Message::get($key); * $string = "$foo"; + * @since 1.18 * @return String */ public function __toString() { @@ -449,6 +457,7 @@ class Message { /** * Fully parse the text from wikitext to HTML + * @since 1.17 * @return String parsed HTML */ public function parse() { @@ -458,6 +467,7 @@ class Message { /** * Returns the message text. {{-transformation is done. + * @since 1.17 * @return String: Unescaped message text. */ public function text() { @@ -467,6 +477,7 @@ class Message { /** * Returns the message text as-is, only parameters are subsituted. + * @since 1.17 * @return String: Unescaped untransformed message text. */ public function plain() { @@ -476,6 +487,7 @@ class Message { /** * Returns the parsed message text which is always surrounded by a block element. + * @since 1.17 * @return String: HTML */ public function parseAsBlock() { @@ -486,6 +498,7 @@ class Message { /** * Returns the message text. {{-transformation is done and the result * is escaped excluding any raw parameters. + * @since 1.17 * @return String: Escaped message text. */ public function escaped() { @@ -495,6 +508,7 @@ class Message { /** * Check whether a message key has been defined currently. + * @since 1.17 * @return Bool: true if it is and false if not. */ public function exists() { @@ -503,6 +517,7 @@ class Message { /** * Check whether a message does not exist, or is an empty string + * @since 1.18 * @return Bool: true if is is and false if not * @todo FIXME: Merge with isDisabled()? */ @@ -513,6 +528,7 @@ class Message { /** * Check whether a message does not exist, is an empty string, or is "-" + * @since 1.18 * @return Bool: true if is is and false if not */ public function isDisabled() { @@ -521,6 +537,7 @@ class Message { } /** + * @since 1.17 * @param $value * @return array */ @@ -529,6 +546,7 @@ class Message { } /** + * @since 1.18 * @param $value * @return array */ @@ -538,6 +556,7 @@ class Message { /** * Substitutes any paramaters into the message text. + * @since 1.17 * @param $message String: the message text * @param $type String: either before or after * @return String @@ -556,6 +575,7 @@ class Message { /** * Extracts the parameter type and preprocessed the value if needed. + * @since 1.18 * @param $param String|Array: Parameter as defined in this class. * @return Tuple(type, value) * @throws MWException @@ -576,6 +596,7 @@ class Message { /** * Wrapper for what ever method we use to parse wikitext. + * @since 1.17 * @param $string String: Wikitext message contents * @return string Wikitext parsed into HTML */ @@ -585,6 +606,7 @@ class Message { /** * Wrapper for what ever method we use to {{-transform wikitext. + * @since 1.17 * @param $string String: Wikitext message contents * @return string Wikitext with {{-constructs replaced with their values. */ @@ -594,7 +616,7 @@ class Message { /** * Wrapper for what ever method we use to get message contents - * + * @since 1.17 * @return string */ protected function fetchMessage() {