Changes in the PHP doc comments

Author: richardhj

src/MetaModels/IItem.php

@@ -107,14 +107,16 @@ public function isVariantBase();
      *
      * @param \MetaModels\Filter\IFilter $objFilter The filter settings to be applied.
      *
-     * @return \MetaModels\IItems A list of all variants for this item.
+     * @return \MetaModels\IItems|null A list of all variants for this item or null if the item cannot handle variants.
      */
     public function getVariants($objFilter);
 
     /**
-     * Fetch the meta model variant base for this item. For a non-variant item the variant base is the item itself.
+     * Fetch the meta model variant base for this item.
      *
-     * @return \MetaModels\IItem The variant base.
+     * Note: For a non-variant item the variant base is the item itself.
+     *
+     * @return IItem The variant base.
      */
     public function getVariantBase();
 

src/MetaModels/Item.php

@@ -283,7 +283,7 @@ public function isVariantBase()
      *
      * @param IFilter $objFilter The filter settings to be applied.
      *
-     * @return IItems A list of all variants for this item.
+     * @return IItems|null A list of all variants for this item.
      */
     public function getVariants($objFilter)
     {
@@ -295,9 +295,11 @@ public function getVariants($objFilter)
     }
 
     /**
-     * Fetch the meta model variant base for this item. For a non-variant item the variant base is the item itself.
+     * Fetch the meta model variant base for this item.
      *
-     * @return \MetaModels\IItem The variant base.
+     * Note: For a non-variant item the variant base is the item itself.
+     *
+     * @return IItem The variant base.
      */
     public function getVariantBase()
     {