Update doc blocks

na2axl · na2axl · commit 64f14bc62793 · 2018-05-19T23:57:57.000+01:00
diff --git a/src/LightQL/Annotations/AutoIncrementAnnotation.php b/src/LightQL/Annotations/AutoIncrementAnnotation.php
@@ -42,11 +42,11 @@
  *
  * @usage('property' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/AutoIncrementAnnotation
  */
 class AutoIncrementAnnotation extends Annotation
 {
-}
+}
diff --git a/src/LightQL/Annotations/ColumnAnnotation.php b/src/LightQL/Annotations/ColumnAnnotation.php
@@ -41,7 +41,7 @@
  *
  * @usage('property' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/ColumnAnnotation
@@ -68,4 +68,4 @@ class ColumnAnnotation extends Annotation
      * @var mixed
      */
     public $default = null;
-}
+}
diff --git a/src/LightQL/Annotations/EntityAnnotation.php b/src/LightQL/Annotations/EntityAnnotation.php
@@ -43,7 +43,7 @@
  *
  * @usage('class' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/EntityAnnotation
@@ -63,4 +63,4 @@ class EntityAnnotation extends Annotation
      * @var integer
      */
     public $fetchMode = Entity::FETCH_LAZY;
-}
+}
diff --git a/src/LightQL/Annotations/IdAnnotation.php b/src/LightQL/Annotations/IdAnnotation.php
@@ -41,11 +41,11 @@
  *
  * @usage('property' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/IdAnnotation
  */
 class IdAnnotation extends Annotation
 {
-}
+}
diff --git a/src/LightQL/Annotations/ManyToManyAnnotation.php b/src/LightQL/Annotations/ManyToManyAnnotation.php
@@ -41,7 +41,7 @@
  *
  * @usage('property' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/ManyToManyAnnotation
@@ -82,4 +82,4 @@ class ManyToManyAnnotation extends Annotation
      * @var string
      */
     public $referencedColumn;
-}
+}
diff --git a/src/LightQL/Annotations/ManyToOneAnnotation.php b/src/LightQL/Annotations/ManyToOneAnnotation.php
@@ -41,7 +41,7 @@
  *
  * @usage('property' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/ManyToOneAnnotation
@@ -68,4 +68,4 @@ class ManyToOneAnnotation extends Annotation
      * @var string
      */
     public $referencedColumn;
-}
+}
diff --git a/src/LightQL/Annotations/NamedQueryAnnotation.php b/src/LightQL/Annotations/NamedQueryAnnotation.php
@@ -43,7 +43,7 @@
  *
  * @usage('class' => true, 'multiple' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/NamedQueryAnnotation
@@ -101,4 +101,4 @@ public function initAnnotation(array $properties)
             throw new AnnotationException(self::class . ' requires a (string) query property.');
         }
     }
-}
+}
diff --git a/src/LightQL/Annotations/NotNullAnnotation.php b/src/LightQL/Annotations/NotNullAnnotation.php
@@ -42,11 +42,11 @@
  *
  * @usage('property' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/NotNullAnnotation
  */
 class NotNullAnnotation extends Annotation
 {
-}
+}
diff --git a/src/LightQL/Annotations/OneToManyAnnotation.php b/src/LightQL/Annotations/OneToManyAnnotation.php
@@ -41,7 +41,7 @@
  *
  * @usage('property' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/OneToManyAnnotation
@@ -61,4 +61,4 @@ class OneToManyAnnotation extends Annotation
      * @var string
      */
     public $mappedBy;
-}
+}
diff --git a/src/LightQL/Annotations/PersistenceUnitAnnotation.php b/src/LightQL/Annotations/PersistenceUnitAnnotation.php
@@ -43,7 +43,7 @@
  *
  * @usage('property' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/IdAnnotation
@@ -81,4 +81,4 @@ public function initAnnotation(array $properties)
             throw new AnnotationException(self::class . ' requires a (string) name property.');
         }
     }
-}
+}
diff --git a/src/LightQL/Annotations/SizeAnnotation.php b/src/LightQL/Annotations/SizeAnnotation.php
@@ -42,7 +42,7 @@
  *
  * @usage('property' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/IdAnnotation
@@ -99,4 +99,4 @@ public function initAnnotation(array $properties)
             throw new AnnotationException(self::class . ' requires a min and/or max property');
         }
     }
-}
+}
diff --git a/src/LightQL/Annotations/UniqueAnnotation.php b/src/LightQL/Annotations/UniqueAnnotation.php
@@ -42,11 +42,11 @@
  *
  * @usage('property' => true, 'inherited' => true)
  *
- * @category Annotation
+ * @category Annotations
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Annotations/UniqueAnnotation
  */
 class UniqueAnnotation extends Annotation
 {
-}
+}
diff --git a/src/LightQL/Entities/Column.php b/src/LightQL/Entities/Column.php
@@ -37,8 +37,7 @@
  *
  * Describe a database column.
  *
- * @abstract
- * @category Library
+ * @category Entities
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Entities/Column
@@ -98,4 +97,4 @@ public function getDefault()
     {
         return $this->_default;
     }
-}
+}
diff --git a/src/LightQL/Entities/Entity.php b/src/LightQL/Entities/Entity.php
@@ -42,7 +42,7 @@
  * Object Oriented Mapping of a database row.
  *
  * @abstract
- * @category Library
+ * @category Entities
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Entities/Entity
@@ -221,4 +221,4 @@ private function _exists(string $column): bool
     {
         return array_key_exists($column, $this->raw);
     }
-}
+}
diff --git a/src/LightQL/Entities/EntityManager.php b/src/LightQL/Entities/EntityManager.php
@@ -41,8 +41,8 @@
  *
  * Manage all entities, using one same persistence unit.
  *
- * @abstract
- * @category Library
+ * @final
+ * @category Entities
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Entities/PersistenceUnit
@@ -236,4 +236,4 @@ public function getLightQL(): LightQL
     {
         return $this->_lightql;
     }
-}
+}
diff --git a/src/LightQL/Entities/IEntity.php b/src/LightQL/Entities/IEntity.php
@@ -37,8 +37,7 @@
  *
  * Provides default methods for all entities.
  *
- * @abstract
- * @category Interfaces
+ * @category Entities
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Entities/IDatabaseEntity
@@ -70,4 +69,4 @@ function get(string $column);
      */
     function set(string $column, $value);
 
-}
+}
diff --git a/src/LightQL/Entities/Query.php b/src/LightQL/Entities/Query.php
@@ -39,7 +39,7 @@
  *
  * Manage, run and get results from named queries.
  *
- * @category Sessions
+ * @category Entities
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Entities/Query
@@ -129,4 +129,4 @@ public function getFirstResult(): IEntity
         $results = $this->getResults();
         return $results[0];
     }
-}
+}
diff --git a/src/LightQL/Exceptions/EntityException.php b/src/LightQL/Exceptions/EntityException.php
@@ -35,10 +35,11 @@
 /**
  * Entity Exception
  *
- * @package LightQL
- * @author  Nana Axel <ax.lnana@outlook.com>
- * @link    http://lightql.na2axl.tk/docs/api/LightQL/Exceptions/EntityException
+ * @category Exceptions
+ * @package  LightQL
+ * @author   Nana Axel <ax.lnana@outlook.com>
+ * @link     http://lightql.na2axl.tk/docs/api/LightQL/Exceptions/EntityException
  */
 class EntityException extends \Exception
 {
-}
+}
diff --git a/src/LightQL/Exceptions/FacadeException.php b/src/LightQL/Exceptions/FacadeException.php
@@ -35,11 +35,11 @@
 /**
  * Facade Exception
  *
- * @category Exception
+ * @category Exceptions
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Exceptions/FacadeException
  */
 class FacadeException extends \Exception
 {
-}
+}
diff --git a/src/LightQL/Exceptions/LightQLException.php b/src/LightQL/Exceptions/LightQLException.php
@@ -35,6 +35,7 @@
 /**
  * LightQL Exception
  *
+ * @category Exceptions
  * @package LightQL
  * @author  Nana Axel <ax.lnana@outlook.com>
  * @link    http://lightql.na2axl.tk/docs/api/LightQL/Exceptions/LightQLException
diff --git a/src/LightQL/Exceptions/PersistenceUnitException.php b/src/LightQL/Exceptions/PersistenceUnitException.php
@@ -35,11 +35,12 @@
 /**
  * Persistence Unit Exception
  *
+ * @category Exceptions
  * @package LightQL
  * @author  Nana Axel <ax.lnana@outlook.com>
  * @link    http://lightql.na2axl.tk/docs/api/LightQL/Exceptions/PersistenceUnitException
  */
 class PersistenceUnitException extends \Exception
 {
 
-}
+}
diff --git a/src/LightQL/Exceptions/QueryException.php b/src/LightQL/Exceptions/QueryException.php
@@ -35,10 +35,11 @@
 /**
  * Query Exception
  *
+ * @category Exceptions
  * @package LightQL
  * @author  Nana Axel <ax.lnana@outlook.com>
  * @link    http://lightql.na2axl.tk/docs/api/LightQL/Exceptions/QueryException
  */
 class QueryException extends \Exception
 {
-}
+}
diff --git a/src/LightQL/Persistence/PersistenceUnit.php b/src/LightQL/Persistence/PersistenceUnit.php
@@ -39,8 +39,7 @@
  *
  * Configures parameters to use for database connection.
  *
- * @abstract
- * @category Library
+ * @category Persistence
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
  * @link     http://lightql.na2axl.tk/docs/api/LightQL/Persistence/PersistenceUnit
@@ -214,4 +213,4 @@ public function getUsername(): string
     {
         return $this->_username;
     }
-}
+}
diff --git a/src/LightQL/Sessions/Facade.php b/src/LightQL/Sessions/Facade.php
@@ -46,6 +46,7 @@
  *
  * Base class for all entity facades.
  *
+ * @abstract
  * @category Sessions
  * @package  LightQL
  * @author   Nana Axel <ax.lnana@outlook.com>
@@ -442,4 +443,4 @@ private function _parseRawEntites($rawEntities, $annotations): array
 
         return $entities;
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -42,11 +42,11 @@`
`42`	`42`	`*`
`43`	`43`	`* @usage('property' => true, 'inherited' => true)`
`44`	`44`	`*`
`45`		`- * @category Annotation`
	`45`	`+ * @category Annotations`
`46`	`46`	`* @package LightQL`
`47`	`47`	`* @author Nana Axel <ax.lnana@outlook.com>`
`48`	`48`	`* @link http://lightql.na2axl.tk/docs/api/LightQL/Annotations/AutoIncrementAnnotation`
`49`	`49`	`*/`
`50`	`50`	`class AutoIncrementAnnotation extends Annotation`
`51`	`51`	`{`
`52`		`-}`
	`52`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@`
`41`	`41`	`*`
`42`	`42`	`* @usage('property' => true, 'inherited' => true)`
`43`	`43`	`*`
`44`		`- * @category Annotation`
	`44`	`+ * @category Annotations`
`45`	`45`	`* @package LightQL`
`46`	`46`	`* @author Nana Axel <ax.lnana@outlook.com>`
`47`	`47`	`* @link http://lightql.na2axl.tk/docs/api/LightQL/Annotations/ColumnAnnotation`
`@@ -68,4 +68,4 @@ class ColumnAnnotation extends Annotation`
`68`	`68`	`* @var mixed`
`69`	`69`	`*/`
`70`	`70`	`public $default = null;`
`71`		`-}`
	`71`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@`
`43`	`43`	`*`
`44`	`44`	`* @usage('class' => true, 'inherited' => true)`
`45`	`45`	`*`
`46`		`- * @category Annotation`
	`46`	`+ * @category Annotations`
`47`	`47`	`* @package LightQL`
`48`	`48`	`* @author Nana Axel <ax.lnana@outlook.com>`
`49`	`49`	`* @link http://lightql.na2axl.tk/docs/api/LightQL/Annotations/EntityAnnotation`
`@@ -63,4 +63,4 @@ class EntityAnnotation extends Annotation`
`63`	`63`	`* @var integer`
`64`	`64`	`*/`
`65`	`65`	`public $fetchMode = Entity::FETCH_LAZY;`
`66`		`-}`
	`66`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -41,11 +41,11 @@`
`41`	`41`	`*`
`42`	`42`	`* @usage('property' => true, 'inherited' => true)`
`43`	`43`	`*`
`44`		`- * @category Annotation`
	`44`	`+ * @category Annotations`
`45`	`45`	`* @package LightQL`
`46`	`46`	`* @author Nana Axel <ax.lnana@outlook.com>`
`47`	`47`	`* @link http://lightql.na2axl.tk/docs/api/LightQL/Annotations/IdAnnotation`
`48`	`48`	`*/`
`49`	`49`	`class IdAnnotation extends Annotation`
`50`	`50`	`{`
`51`		`-}`
	`51`	`+}`