From 77f4cf938bd09819764d0676c91d03f81dae44d3 Mon Sep 17 00:00:00 2001
From: "Bruno O. Notario" <bruno@exacti.com.br>
Date: Mon, 18 Apr 2022 11:00:06 -0300
Subject: [PATCH] Few some abstracts and @api in PHPDoc

---
 system/engine/abstracthelper.php |  8 +++++++-
 system/engine/controller.php     |  1 +
 system/engine/document.php       |  1 -
 system/engine/exception.php      |  2 ++
 system/engine/model.php          | 10 +++++++++-
 system/engine/response.php       |  4 +++-
 system/engine/restful.php        | 11 +++--------
 7 files changed, 25 insertions(+), 12 deletions(-)

diff --git a/system/engine/abstracthelper.php b/system/engine/abstracthelper.php
index 4803943..e2b937c 100644
--- a/system/engine/abstracthelper.php
+++ b/system/engine/abstracthelper.php
@@ -8,7 +8,13 @@
 
 namespace Phacil\Framework;
 
-/** @package Phacil\Framework */
+/** 
+ * Abstract class for helpers
+ * 
+ * @package Phacil\Framework 
+ * @abstract
+ * @api
+ */
 abstract class AbstractHelper {
 	
 	/**
diff --git a/system/engine/controller.php b/system/engine/controller.php
index 1a282de..3c3efe2 100644
--- a/system/engine/controller.php
+++ b/system/engine/controller.php
@@ -33,6 +33,7 @@ use \Phacil\Framework\Config;
  * @abstract
  * @package Phacil\Framework 
  * @since 0.1.0
+ * @api
  */
 abstract class Controller {
     /**
diff --git a/system/engine/document.php b/system/engine/document.php
index fe656ec..9a5c266 100644
--- a/system/engine/document.php
+++ b/system/engine/document.php
@@ -242,5 +242,4 @@ class Document {
 
     }
 
-
 }
diff --git a/system/engine/exception.php b/system/engine/exception.php
index d92b156..ba2730d 100644
--- a/system/engine/exception.php
+++ b/system/engine/exception.php
@@ -13,8 +13,10 @@ namespace Phacil\Framework;
 
 /**
  * Exception extended for log on destruct
+ * 
  * @since 2.0.0
  * @package Phacil\Framework
+ * @api
  */
 class Exception extends \Exception
 {
diff --git a/system/engine/model.php b/system/engine/model.php
index d11f8d6..d90fcd6 100644
--- a/system/engine/model.php
+++ b/system/engine/model.php
@@ -9,7 +9,15 @@
 
 namespace Phacil\Framework;
 
-/** @package Phacil\Framework */
+/** 
+ * The default model class.
+ * 
+ * @example class MyModel extends \Phacil\Framework\Model
+ * 
+ * @package Phacil\Framework 
+ * @abstract
+ * @api
+ */
 abstract class Model {
 	
 	/**
diff --git a/system/engine/response.php b/system/engine/response.php
index f8d59a1..78660aa 100644
--- a/system/engine/response.php
+++ b/system/engine/response.php
@@ -13,7 +13,9 @@ namespace Phacil\Framework;
  * 
  * @since 0.0.1
  * 
- * @package Phacil\Framework */
+ * @package Phacil\Framework
+ * @api
+ */
 final class Response {
 
 	/**
diff --git a/system/engine/restful.php b/system/engine/restful.php
index ed2e5be..c0890d6 100644
--- a/system/engine/restful.php
+++ b/system/engine/restful.php
@@ -16,8 +16,10 @@ use Phacil\Framework\Controller;
  * 
  * @package Phacil\Framework
  * @since 2.0.0
+ * @abstract
+ * @api
  */
-class RESTful extends Controller {
+abstract class RESTful extends Controller {
 
 	/**
 	 * The output content type
@@ -69,11 +71,6 @@ class RESTful extends Controller {
 		if (in_array($method, $this->HTTPMETHODS) && is_callable(array($this, $method))) {
 			$r = new ReflectionMethod($this, $method);
 			$params = [];
-			/* $requiredParamsTotal = $r->getNumberOfRequiredParameters();
-
-			$requiredParams = $r->getRequiredParameters();
-
-			$vondc = $r->getParameters(); */
 
 			$comment_string = $r->getDocCommentParse();
 
@@ -125,7 +122,6 @@ class RESTful extends Controller {
 									$invalidDataType = false;
 								}
 							}
-
 							
 							if($invalidDataType){
 								return $this->__callInterrupt($value->getName() . " need to be: ".(is_array($type) ? implode(', ', $type) : $type).". You give: ".gettype($data).".");
@@ -155,7 +151,6 @@ class RESTful extends Controller {
 			} catch (Exception $e) {
 				throw new Exception($e->getMessage(), $e->getCode());
 			}
-			//$this->$method();
 		} else {
 			$this->__callNotFound($method);
 		}