andela-tolotin / Potato-ORM

src/Database/DatabaseHandler.php

Doc Comments +7 added lines, -1 removed lines

@@ -16,6 +16,7 @@ 
 
     /**
      * This is a constructor; a default method  that will be called automatically during class instantiation.
+     * @param string|false $modelClassName
      */
     public function __construct($modelClassName, $dbConn = null)
     {
@@ -32,6 +33,7 @@ 
      * This method create a record and store it in a table row.
      *
      * @params associative array, string tablename
+     * @param string|false $tableName
      *
      * @return bool true or false
      */
@@ -91,6 +93,7 @@ 
      * This method updates any table by supplying 3 parameter.
      *
      * @params: $updateParams, $tableName, $associative1DArray
+     * @param string|false $tableName
      *
      * @return bool true or false
      */
@@ -137,6 +140,7 @@ 
     * This method retrieves record from a table.
     *
     * @params int id, string tableName
+    * @param string|false $tableName
     *
     * @return array
     */
@@ -168,6 +172,7 @@ 
    * This method deletes a record  from a table row.
    *
    * @params int id, string tableName
+   * @param string|false $tableName
    *
    * @return bool true or false
    */
@@ -212,7 +217,7 @@ 
   /**
    * This method returns sql query.
    *
-   * @param $sql
+   * @param string $sql
    *
    * @return string
    */
@@ -265,6 +270,7 @@ 
    *
    * @param $table
    * @param $conn
+   * @param DatabaseConnection $dbConn
    *
    * @return array
    */

src/Model/BaseModel.php

Doc Comments +2 added lines, -2 removed lines

@@ -120,7 +120,7 @@ 
      *
      * @throws NoArgumentPassedToFunctionException
      *
-     * @return object
+     * @return BaseModel
      */
     public static function find($id)
     {
@@ -171,7 +171,7 @@ 
     * This method return the current class name
     * $params void.
     *
-    * @return classname
+    * @return string|false
     */
    public static function getClassName()
    {