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/Builder/DocComment.php

Doc Comments +9 added lines

@@ -43,6 +43,9 @@ 
 		self::$parsedFiles = [];
 	}
 
+	/**
+	 * @param Reflector $reflection
+	 */
 	public function get($reflection)
 	{
 		if ($reflection instanceof ReflectionClass)
@@ -142,6 +145,9 @@ 
 		return isset(self::$fields[$class][$field]) ? self::$fields[$class][$field] : false;
 	}
 
+	/**
+	 * @param string $fqn
+	 */
 	private function processAnonymous(Reflector $reflection, $fqn)
 	{
 		if (!isset(self::$parsedFiles[$fqn]))
@@ -322,6 +328,9 @@ 
 		return $fqn;
 	}
 
+	/**
+	 * @param integer $max
+	 */
 	private function getString($tokens, &$i, $max)
 	{
 		do

src/Cache/ClassCache.php

Doc Comments +10 added lines

@@ -103,6 +103,9 @@ 
 		$this->checker = new Checker($this->basePath);
 	}
 
+	/**
+	 * @param string $className
+	 */
 	public function get($className)
 	{
 		assert(!empty($className));
@@ -118,6 +121,10 @@ 
 		return $data;
 	}
 
+	/**
+	 * @param string $className
+	 * @param \Maslosoft\Addendum\Collections\Meta $data
+	 */
 	public function set($className, $data): bool
 	{
 		$this->cleaner->clean($className);
@@ -137,6 +144,9 @@ 
 		$this->nsCache->setOptions($options);
 	}
 
+	/**
+	 * @return string
+	 */
 	private function getInstanceId(MetaOptions $options = null)
 	{
 		if (empty($options))