Update PHPDoc blocks (#196)

* Update PHPDoc blocks

* PHPDocs: Remove @param and @return comments from actionSql()

* PHPDocs: Remove @param and @return comments where the param and return is already implied in the code

---------

Co-authored-by: Bizley <[email protected]>

Author: craiglondon

src/TableMapper.php

@@ -123,7 +123,6 @@ private function getIndexes(string $table): array
 
     /**
      * Returns a primary key of the table.
-     * @return PrimaryKeyInterface|null
      * @throws NotSupportedException
      */
     private function getPrimaryKey(string $table): ?PrimaryKeyInterface

src/controllers/MigrationController.php

@@ -8,9 +8,11 @@
 use bizley\migration\table\BlueprintInterface;
 use bizley\migration\table\ForeignKeyInterface;
 use bizley\migration\TableMissingException;
+use ErrorException;
+use Exception;
 use Yii;
 use yii\base\Action;
-use yii\base\Exception;
+use yii\base\Exception as BaseException;
 use yii\base\InvalidConfigException;
 use yii\base\NotSupportedException;
 use yii\console\ExitCode;
@@ -163,8 +165,8 @@ public function optionAliases(): array
      * Sets the workingPath and workingNamespace and makes sure DB connection is prepared.
      * @param Action<self> $action the action to be executed.
      * @return bool whether the action should continue to be executed.
+     * @throws BaseException
      * @throws InvalidConfigException
-     * @throws Exception
      */
     public function beforeAction($action): bool // BC declaration
     {
@@ -586,7 +588,11 @@ public function actionUpdate(string $inputTable): int
         return ExitCode::OK;
     }
 
-    /** @since 4.4.0 */
+    /**
+     * @since 4.4.0
+     * @throws ErrorException
+     * @throws InvalidConfigException
+     */
     public function actionSql(string $migrationName, string $method = 'up'): int
     {
         $method = \strtolower($method);
@@ -615,7 +621,7 @@ public function actionSql(string $migrationName, string $method = 'up'): int
 
     /**
      * Prepares path directory. If directory doesn't exist it's being created.
-     * @throws Exception
+     * @throws BaseException
      */
     private function preparePathDirectory(string $path): string
     {
@@ -632,7 +638,7 @@ private function preparePathDirectory(string $path): string
     /**
      * Stores the content in a file under the given path.
      * @param mixed $content
-     * @throws \Throwable
+     * @throws BaseException
      */
     public function storeFile(string $path, $content): void
     {
@@ -662,6 +668,7 @@ private function fixHistory(string $migrationClassName): void
     /**
      * Generates migration for postponed foreign keys.
      * @param array<ForeignKeyInterface> $postponedForeignKeys
+     * @throws BaseException
      * @throws DbException
      * @throws InvalidConfigException
      * @throws NotSupportedException
@@ -692,6 +699,7 @@ private function generateMigrationForForeignKeys(array $postponedForeignKeys, st
 
     /**
      * Generates updating migration based on a blueprint.
+     * @throws BaseException
      * @throws DbException
      * @throws InvalidConfigException
      * @throws NotSupportedException
@@ -721,6 +729,7 @@ private function generateMigrationWithBlueprint(BlueprintInterface $blueprint, s
     /**
      * Generates creating migration based on a table structure.
      * @param array<string> $referencesToPostpone
+     * @throws BaseException
      * @throws DbException
      * @throws InvalidConfigException
      * @throws NotSupportedException
@@ -897,7 +906,8 @@ private function getAllTableNames(Connection $db): array
      * via the server's filesystem.
      * Note: On Windows, this function fails silently when applied on a regular file.
      * @param string $path the path to the file or directory.
-     * @throws \Exception
+     * @throws BaseException
+     * @throws Exception
      */
     private function setFileModeAndOwnership(string $path): void
     {

src/table/TimestampColumn.php

@@ -29,7 +29,6 @@ public function setDefault($default): void
     /**
      * Checks if schema supports length for this column.
      * In case of MySQL the engine version must be 5.6.4 or newer.
-     * @return bool
      */
     private function isSchemaLengthSupporting(?string $schema, ?string $engineVersion): bool
     {