Commit c35d3af0 by pupi1985

Add @since PHPDoc tag to recent method additions

parent ce3f945e
...@@ -2361,6 +2361,7 @@ function qa_favorite_form($entitytype, $entityid, $favorite, $title) ...@@ -2361,6 +2361,7 @@ function qa_favorite_form($entitytype, $entityid, $favorite, $title)
* Format a number using the decimal point and thousand separator specified in the language files. * Format a number using the decimal point and thousand separator specified in the language files.
* If the number is compacted it is turned into a string such as 1.3k or 2.5m. * If the number is compacted it is turned into a string such as 1.3k or 2.5m.
* *
* @since 1.8.0
* @param integer $number Number to be formatted * @param integer $number Number to be formatted
* @param integer $decimals Amount of decimals to use (ignored if number gets shortened) * @param integer $decimals Amount of decimals to use (ignored if number gets shortened)
* @param bool $compact Whether the number can be shown as compact or not * @param bool $compact Whether the number can be shown as compact or not
......
...@@ -237,6 +237,7 @@ function qa_post_set_closed($questionid, $closed = true, $originalpostid = null, ...@@ -237,6 +237,7 @@ function qa_post_set_closed($questionid, $closed = true, $originalpostid = null,
/** /**
* Return whether the given question is closed. This check takes into account the do_close_on_select option which * Return whether the given question is closed. This check takes into account the do_close_on_select option which
* considers questions with a selected answer as closed. * considers questions with a selected answer as closed.
* @since 1.8.2
* @param array $question * @param array $question
* @return bool * @return bool
*/ */
......
...@@ -518,6 +518,7 @@ if (QA_FINAL_EXTERNAL_USERS) { ...@@ -518,6 +518,7 @@ if (QA_FINAL_EXTERNAL_USERS) {
* Return the URL to the $blobId with a stored size of $width and $height. * Return the URL to the $blobId with a stored size of $width and $height.
* Constrain the image to $size (width AND height) * Constrain the image to $size (width AND height)
* *
* @since 1.8.0
* @param string $blobId The blob ID from the image * @param string $blobId The blob ID from the image
* @param int|null $size The resulting image's size. If omitted the original image size will be used. If the * @param int|null $size The resulting image's size. If omitted the original image size will be used. If the
* size is present it must be greater than 0 * size is present it must be greater than 0
...@@ -582,6 +583,7 @@ if (QA_FINAL_EXTERNAL_USERS) { ...@@ -582,6 +583,7 @@ if (QA_FINAL_EXTERNAL_USERS) {
* the user's profile, 'local-default' for an avatar fetched locally from the default avatar blob ID, and NULL * the user's profile, 'local-default' for an avatar fetched locally from the default avatar blob ID, and NULL
* if the avatar could not be fetched from any of these sources * if the avatar could not be fetched from any of these sources
* *
* @since 1.8.0
* @param int $flags The user's flags * @param int $flags The user's flags
* @param string|null $email The user's email * @param string|null $email The user's email
* @param string|null $blobId The blob ID for a locally stored avatar. * @param string|null $blobId The blob ID for a locally stored avatar.
...@@ -1401,6 +1403,7 @@ function qa_check_form_security_code($action, $value) ...@@ -1401,6 +1403,7 @@ function qa_check_form_security_code($action, $value)
/** /**
* Return the URL for the Gravatar corresponding to $email, constrained to $size * Return the URL for the Gravatar corresponding to $email, constrained to $size
* *
* @since 1.8.0
* @param string $email The email of the Gravatar to return * @param string $email The email of the Gravatar to return
* @param int|null $size The size of the Gravatar to return. If omitted the default size will be used * @param int|null $size The size of the Gravatar to return. If omitted the default size will be used
* @return string The URL to the Gravatar of the user * @return string The URL to the Gravatar of the user
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment