Maslosoft / Addendum

src/Reflection/ReflectionAnnotatedClass.php

Doc Comments +9 added lines

@@ -44,11 +44,17 @@ 
 		ConflictChecker::check($this, $this->annotations);
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function hasAnnotation($class)
 	{
 		return $this->annotations->hasAnnotation($class);
 	}
 
+	/**
+	 * @param string $annotation
+	 */
 	public function getAnnotation($annotation)
 	{
 		return $this->annotations->getAnnotation($annotation);
@@ -125,6 +131,9 @@ 
 		return ($method !== null) ? new ReflectionAnnotatedMethod($this->name, $method->name, $this->addendum) : null;
 	}
 
+	/**
+	 * @param \ReflectionProperty $property
+	 */
 	private function createReflectionAnnotatedProperty($property)
 	{
 		return ($property !== null) ? new ReflectionAnnotatedProperty($this->name, $property->name, $this->addendum) : null;

src/Reflection/ReflectionFile.php

Doc Comments +13 added lines, -20 removed lines

@@ -85,13 +85,6 @@ 
 	 * (PHP 5)<br/>
 	 * Exports a class
 	 * @link http://php.net/manual/en/reflectionclass.export.php
-	 * @param mixed $argument <p>
-	 * The reflection to export.
-	 * </p>
-	 * @param bool $return [optional] <p>
-	 * Setting to <b>TRUE</b> will return the export,
-	 * as opposed to emitting it. Setting to <b>FALSE</b> (the default) will do the opposite.
-	 * </p>
 	 * @return string If the <i>return</i> parameter
 	 * is set to <b>TRUE</b>, then the export is returned as a string,
 	 * otherwise <b>NULL</b> is returned.
@@ -116,7 +109,7 @@ 
 	 * (PHP 5)<br/>
 	 * Checks if class is defined internally by an extension, or the core
 	 * @link http://php.net/manual/en/reflectionclass.isinternal.php
-	 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
+	 * @return boolean|null <b>TRUE</b> on success or <b>FALSE</b> on failure.
 	 */
 	public function isInternal()
 	{
@@ -138,7 +131,7 @@ 
 	 * (PHP 5)<br/>
 	 * Checks if the class is instantiable
 	 * @link http://php.net/manual/en/reflectionclass.isinstantiable.php
-	 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
+	 * @return boolean|null <b>TRUE</b> on success or <b>FALSE</b> on failure.
 	 */
 	public function isInstantiable()
 	{
@@ -149,7 +142,7 @@ 
 	 * (PHP &gt;= 5.4.0)<br/>
 	 * Returns whether this class is cloneable
 	 * @link http://php.net/manual/en/reflectionclass.iscloneable.php
-	 * @return bool <b>TRUE</b> if the class is cloneable, <b>FALSE</b> otherwise.
+	 * @return boolean|null <b>TRUE</b> if the class is cloneable, <b>FALSE</b> otherwise.
 	 */
 	public function isCloneable()
 	{
@@ -317,7 +310,7 @@ 
 	 * @param string $name <p>
 	 * The name of the constant being checked for.
 	 * </p>
-	 * @return bool <b>TRUE</b> if the constant is defined, otherwise <b>FALSE</b>.
+	 * @return boolean|null <b>TRUE</b> if the constant is defined, otherwise <b>FALSE</b>.
 	 */
 	public function hasConstant($name)
 	{
@@ -377,7 +370,7 @@ 
 	 * (PHP 5)<br/>
 	 * Checks if the class is an interface
 	 * @link http://php.net/manual/en/reflectionclass.isinterface.php
-	 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
+	 * @return boolean|null <b>TRUE</b> on success or <b>FALSE</b> on failure.
 	 */
 	public function isInterface()
 	{
@@ -426,7 +419,7 @@ 
 	 * (PHP &gt;= 5.4.0)<br/>
 	 * Returns whether this is a trait
 	 * @link http://php.net/manual/en/reflectionclass.istrait.php
-	 * @return bool <b>TRUE</b> if this is a trait, <b>FALSE</b> otherwise.
+	 * @return boolean|null <b>TRUE</b> if this is a trait, <b>FALSE</b> otherwise.
 	 * Returns <b>NULL</b> in case of an error.
 	 */
 	public function isTrait()
@@ -438,7 +431,7 @@ 
 	 * (PHP 5)<br/>
 	 * Checks if class is abstract
 	 * @link http://php.net/manual/en/reflectionclass.isabstract.php
-	 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
+	 * @return boolean|null <b>TRUE</b> on success or <b>FALSE</b> on failure.
 	 */
 	public function isAbstract()
 	{
@@ -449,7 +442,7 @@ 
 	 * (PHP 5)<br/>
 	 * Checks if class is final
 	 * @link http://php.net/manual/en/reflectionclass.isfinal.php
-	 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
+	 * @return boolean|null <b>TRUE</b> on success or <b>FALSE</b> on failure.
 	 */
 	public function isFinal()
 	{
@@ -475,7 +468,7 @@ 
 	 * @param object $object <p>
 	 * The object being compared to.
 	 * </p>
-	 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
+	 * @return boolean|null <b>TRUE</b> on success or <b>FALSE</b> on failure.
 	 */
 	public function isInstance($object)
 	{
@@ -541,7 +534,7 @@ 
 	 * @param string $class <p>
 	 * The class name being checked against.
 	 * </p>
-	 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
+	 * @return boolean|null <b>TRUE</b> on success or <b>FALSE</b> on failure.
 	 */
 	public function isSubclassOf($class)
 	{
@@ -611,7 +604,7 @@ 
 	 * (PHP 5)<br/>
 	 * Checks if iterateable
 	 * @link http://php.net/manual/en/reflectionclass.isiterateable.php
-	 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
+	 * @return boolean|null <b>TRUE</b> on success or <b>FALSE</b> on failure.
 	 */
 	public function isIterateable()
 	{
@@ -625,7 +618,7 @@ 
 	 * @param string $interface <p>
 	 * The interface name.
 	 * </p>
-	 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
+	 * @return boolean|null <b>TRUE</b> on success or <b>FALSE</b> on failure.
 	 */
 	public function implementsInterface($interface)
 	{
@@ -648,7 +641,7 @@ 
 	 * (PHP 5)<br/>
 	 * Gets the name of the extension which defined the class
 	 * @link http://php.net/manual/en/reflectionclass.getextensionname.php
-	 * @return string The name of the extension which defined the class, or <b>FALSE</b> for user-defined classes.
+	 * @return boolean The name of the extension which defined the class, or <b>FALSE</b> for user-defined classes.
 	 */
 	public function getExtensionName()
 	{

src/Collections/MetaAnnotation.php

Doc Comments +1 added lines, -1 removed lines

@@ -100,7 +100,7 @@
 	 * }
 	 * ```
 	 *
-	 * @return AnnotatedEntityInteface
+	 * @return AnnotationEntityInterface
 	 */
 	public function getEntity()
 	{

src/Builder/DocComment.php

Doc Comments +6 added lines

@@ -41,6 +41,9 @@ 
 		self::$parsedFiles = [];
 	}
 
+	/**
+	 * @param Reflector $reflection
+	 */
 	public function get($reflection)
 	{
 		if ($reflection instanceof ReflectionClass)
@@ -275,6 +278,9 @@ 
 		return $fqn;
 	}
 
+	/**
+	 * @param integer $max
+	 */
 	private function getString($tokens, &$i, $max)
 	{
 		do

src/Utilities/TargetChecker.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 	/**
 	 * Check target constraints
 	 * @param AnnotationInterface $annotation Annotation
-	 * @param ReflectionClass|ReflectionMethod|ReflectionProperty|bool $target
+	 * @param boolean $target
 	 * @return type
 	 * @throws TargetException
 	 */

src/Cache/PhpCache.php

Doc Comments +4 added lines, -1 removed lines

@@ -250,7 +250,7 @@ 
 
 	/**
 	 * Clear entire cache
-	 * @return boolean
+	 * @return false|null
 	 */
 	public function clear()
 	{
@@ -264,6 +264,9 @@ 
 		return $this->clearPath($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	private function clearPath($path)
 	{
 		if (!file_exists($path))

src/Annotation.php

Unused Use Statements -1 removed lines

@@ -15,7 +15,6 @@
 namespace Maslosoft\Addendum;
 
 use Maslosoft\Addendum\Exceptions\CircularReferenceException;
-use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
 use Maslosoft\Addendum\Interfaces\AnnotationInterface;
 use Maslosoft\Addendum\Utilities\ConflictChecker;
 use Maslosoft\Addendum\Utilities\TargetChecker;

src/Collections/Meta.php

Doc Comments +1 added lines, -1 removed lines

@@ -241,7 +241,7 @@
 	 * Calling this function will create new instance only if it's not stored in cache.
 	 * This allows very effective retrieving of `Meta` container's meta data, without need of parsing annotations.
 	 * @param string|object|AnnotatedInterface $model
-	 * @param MetaOption|null $options
+	 * @param null|MetaOptions $options
 	 * @return static
 	 */
 	public static function create($model, MetaOptions $options = null)