aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Category.php
diff options
context:
space:
mode:
authorumherirrender <umherirrender_de.wp@web.de>2014-04-20 21:16:57 +0200
committerumherirrender <umherirrender_de.wp@web.de>2014-04-20 21:16:57 +0200
commit8ad1c9244125747f0ef0a8e1e053d04bbfebe19d (patch)
tree9620ab30fc986cb9718fb737c6a285f739c48b5b /includes/Category.php
parent79ebb4b0288b709fb53cff8f7ebc5f50221931c9 (diff)
downloadmediawikicore-8ad1c9244125747f0ef0a8e1e053d04bbfebe19d.tar.gz
mediawikicore-8ad1c9244125747f0ef0a8e1e053d04bbfebe19d.zip
Fixed some @params documentation (includes/*)
Swapped some "$var type" to "type $var" or added missing types before the $var. Changed some other types to match the more common spelling. Makes beginning of some text in captial. Also added some missing @param. Change-Id: I7f605aa9e117b5fd80d9b1440864fe526d2b14a5
Diffstat (limited to 'includes/Category.php')
-rw-r--r--includes/Category.php16
1 files changed, 8 insertions, 8 deletions
diff --git a/includes/Category.php b/includes/Category.php
index e326ce23cdfa..e235e4e94e9e 100644
--- a/includes/Category.php
+++ b/includes/Category.php
@@ -129,8 +129,8 @@ class Category {
/**
* Factory function.
*
- * @param $title Title for the category page
- * @return Category|bool on a totally invalid name
+ * @param Title $title Title for the category page
+ * @return Category|bool On a totally invalid name
*/
public static function newFromTitle( $title ) {
$cat = new self();
@@ -144,7 +144,7 @@ class Category {
/**
* Factory function.
*
- * @param $id Integer: a category id
+ * @param int $id A category id
* @return Category
*/
public static function newFromID( $id ) {
@@ -156,11 +156,11 @@ class Category {
/**
* Factory function, for constructing a Category object from a result set
*
- * @param $row Result set row, must contain the cat_xxx fields. If the
+ * @param object $row Result set row, must contain the cat_xxx fields. If the
* fields are null, the resulting Category object will represent an empty
* category if a title object was given. If the fields are null and no
* title was given, this method fails and returns false.
- * @param Title $title optional title object for the category represented by
+ * @param Title $title Optional title object for the category represented by
* the given row. May be provided if it is already known, to avoid having
* to re-create a title object later.
* @return Category
@@ -253,9 +253,9 @@ class Category {
/**
* Fetch a TitleArray of up to $limit category members, beginning after the
* category sort key $offset.
- * @param $limit integer
- * @param $offset string
- * @return TitleArray object for category members.
+ * @param int $limit
+ * @param string $offset
+ * @return TitleArray TitleArray object for category members.
*/
public function getMembers( $limit = false, $offset = '' ) {
wfProfileIn( __METHOD__ );