fix: unable to generate docs

A PHP CS Fixer rule was changing the API Docs documentation in an unexpected way which was causing an error while generating the docs.
apiato · Jul 15, 2023 · e1ae32f · e1ae32f
1 parent 4e1d128
commit e1ae32f
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 6 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -19,5 +19,6 @@
         'phpdoc_align' => [
             'align' => 'left',
         ],
+        'ignored_tags' => false
     ])
     ->setFinder($finder);
diff --git a/app/Containers/AppSection/Authorization/UI/API/Routes/_permission.v1.private.php b/app/Containers/AppSection/Authorization/UI/API/Routes/_permission.v1.private.php
@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * @apiDefine PermissionSuccessSingleResponse
  *
  * @apiSuccess {Object[]}   data
@@ -32,7 +32,7 @@
  * }
  */
 
-/*
+/**
  * @apiDefine PermissionSuccessMultipleResponse
  *
  * @apiQuery {String} [include]

diff --git a/app/Containers/AppSection/Authorization/UI/API/Routes/_role.v1.private.php b/app/Containers/AppSection/Authorization/UI/API/Routes/_role.v1.private.php
@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * @apiDefine RoleSuccessSingleResponse
  *
  * @apiSuccess {Object[]}   data
@@ -40,7 +40,7 @@
  * }
  */
 
-/*
+/**
  * @apiDefine RoleSuccessMultipleResponse
  *
  * @apiQuery {String} [include]

diff --git a/app/Containers/AppSection/User/UI/API/Routes/_user.v1.private.php b/app/Containers/AppSection/User/UI/API/Routes/_user.v1.private.php
@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * @apiDefine UserSuccessSingleResponse
  *
  * @apiSuccess {Object[]}   data
@@ -46,7 +46,7 @@
  * }
  */
 
-/*
+/**
  * @apiDefine UserSuccessMultipleResponse
  *
  * @apiQuery {String} [include]