Add missing method documentation in category classes
authorMatthias Schmidt <gravatronics@live.com>
Sun, 17 Jul 2016 08:38:25 +0000 (10:38 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Sun, 17 Jul 2016 08:44:35 +0000 (10:44 +0200)
wcfsetup/install/files/lib/data/article/category/ArticleCategory.class.php
wcfsetup/install/files/lib/data/category/Category.class.php
wcfsetup/install/files/lib/data/smiley/category/SmileyCategory.class.php

index b7f68fd59bd677a241be0fec7c2bbc226463fce1..7936cb9b62ac8056baa1c977f57891e85807e39f 100644 (file)
@@ -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 {
index 484568ce8261b96beb5d87a11638d7257ccd59b9..9069c5751f06df7f20cc341fc33df5951a9f4236 100644 (file)
@@ -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) {
index 4e9984ddc3056b42216c72a52d972fbb79a4c103..d38eb46d4fefa81f99f6c3342a151441e50694ff 100644 (file)
@@ -14,6 +14,11 @@ use wcf\system\WCF;
  * @copyright  2001-2016 WoltLab GmbH
  * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @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 {
        /**