From f745305574eff52b7de9e1a5c92db0503d6fb1fa Mon Sep 17 00:00:00 2001 From: Matthias Schmidt Date: Sun, 17 Jul 2016 10:38:25 +0200 Subject: [PATCH] Add missing method documentation in category classes --- .../lib/data/article/category/ArticleCategory.class.php | 3 +++ wcfsetup/install/files/lib/data/category/Category.class.php | 4 ++-- .../files/lib/data/smiley/category/SmileyCategory.class.php | 5 +++++ 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/wcfsetup/install/files/lib/data/article/category/ArticleCategory.class.php b/wcfsetup/install/files/lib/data/article/category/ArticleCategory.class.php index b7f68fd59b..7936cb9b62 100644 --- a/wcfsetup/install/files/lib/data/article/category/ArticleCategory.class.php +++ b/wcfsetup/install/files/lib/data/article/category/ArticleCategory.class.php @@ -18,6 +18,9 @@ use wcf\system\WCF; * @package WoltLabSuite\Core\Data\Article\Category * @since 3.0 * + * @method ArticleCategory[] getChildCategories() + * @method ArticleCategory getParentCategory() + * @method ArticleCategory[] getParentCategories() * @method static ArticleCategory|null getCategory($categoryID) */ class ArticleCategory extends AbstractDecoratedCategory implements ITitledLinkObject { diff --git a/wcfsetup/install/files/lib/data/category/Category.class.php b/wcfsetup/install/files/lib/data/category/Category.class.php index 484568ce82..9069c5751f 100644 --- a/wcfsetup/install/files/lib/data/category/Category.class.php +++ b/wcfsetup/install/files/lib/data/category/Category.class.php @@ -138,9 +138,9 @@ class Category extends ProcessibleDatabaseObject implements IPermissionObject, I } /** - * Returns the parent category of this category. + * Returns the parent category of the category or `null` if the category has no parent category. * - * @return Category + * @return Category|null */ public function getParentCategory() { if ($this->parentCategoryID && $this->parentCategory === null) { diff --git a/wcfsetup/install/files/lib/data/smiley/category/SmileyCategory.class.php b/wcfsetup/install/files/lib/data/smiley/category/SmileyCategory.class.php index 4e9984ddc3..d38eb46d4f 100644 --- a/wcfsetup/install/files/lib/data/smiley/category/SmileyCategory.class.php +++ b/wcfsetup/install/files/lib/data/smiley/category/SmileyCategory.class.php @@ -14,6 +14,11 @@ use wcf\system\WCF; * @copyright 2001-2016 WoltLab GmbH * @license GNU Lesser General Public License * @package WoltLabSuite\Core\Data\Smiley\Category + * + * @method SmileyCategory[] getChildCategories() + * @method SmileyCategory getParentCategory() + * @method SmileyCategory[] getParentCategories() + * @method static SmileyCategory|null getCategory($categoryID) */ class SmileyCategory extends AbstractDecoratedCategory implements \Countable, ITraversableObject { /** -- 2.20.1