Inspection of "Finish api doc generator" - SherifElfadaly/Laravel-Api-Skeleton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5c1ad5...6c0ec9 )

by Sherif

created 2017-05-09 12:54 UTC

Status

Unused Use Statements -1 removed lines patch added patch discarded remove patch

@@ -1,6 +1,5 @@
 block discarded – undo
 <?php namespace App\Modules\V1\Acl;
 
-use Illuminate\Database\Eloquent\Model;
 use App\User;
 use Illuminate\Database\Eloquent\SoftDeletes;
 

Please login to merge, or discard this patch.

src/Modules/V1/Core/AbstractRepositories/AbstractRepository.php 1 patch

Doc Comments +8 added lines, -8 removed lines patch added patch discarded remove patch

@@ -32,7 +32,7 @@  discard block
 block discarded – undo
      *
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -50,7 +50,7 @@  discard block
 block discarded – undo
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -139,7 +139,7 @@  discard block
 block discarded – undo
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -418,7 +418,7 @@  discard block
 block discarded – undo
      * Update record in the storage based on the given
      * condition.
      * 
-     * @param  var $value condition value
+     * @param  boolean $value condition value
      * @param  array $data
      * @param  string $attribute condition column name
      * @return void
@@ -479,7 +479,7 @@  discard block
 block discarded – undo
      * id.
      * 
      * @param  integer $id
-     * @param  array   $relations
+     * @param  string[]   $relations
      * @param  array   $columns
      * @return object
      */
@@ -495,7 +495,7 @@  discard block
 block discarded – undo
      * @param  array   $conditions array of conditions
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -527,7 +527,7 @@  discard block
 block discarded – undo
      * @param  array   $conditions array of conditions
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */

Please login to merge, or discard this patch.

src/Modules/V1/Core/Console/Commands/GenerateDoc.php 1 patch

Doc Comments +3 added lines, -2 removed lines patch added patch discarded remove patch

@@ -91,7 +91,7 @@  discard block
 block discarded – undo
      * Generate headers for the given route.
      * 
      * @param  array  &$route
-     * @param  object $reflectionClass
+     * @param  \ReflectionClass $reflectionClass
      * @param  string $method
      * @param  array  $skipLoginCheck
      * @return void
@@ -118,6 +118,7 @@  discard block
 block discarded – undo
      * 
      * @param  array  &$route
      * @param  object $reflectionMethod]
+     * @param \ReflectionMethod $reflectionMethod
      * @return void
      */
     protected function processDocBlock(&$route, $reflectionMethod)
@@ -140,7 +141,7 @@  discard block
 block discarded – undo
      * Generate post body for the given route.
      * 
      * @param  array  &$route
-     * @param  object $reflectionMethod
+     * @param  \ReflectionMethod $reflectionMethod
      * @param  array  $validationRules
      * @return void
      */

Please login to merge, or discard this patch.

src/Modules/V1/Core/Http/Controllers/BaseApiController.php 1 patch

Doc Comments +17 added lines, -17 removed lines patch added patch discarded remove patch

@@ -45,8 +45,8 @@  discard block
 block discarded – undo
      * Fetch all records with relations from storage.
      * 
      * @param  string  $sortBy The name of the column to sort by.
-     * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc   Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function index($sortBy = 'created_at', $desc = 1) 
     {
@@ -60,7 +60,7 @@  discard block
 block discarded – undo
      * Fetch the single object with relations from storage.
      * 
      * @param  integer $id Id of the requested model.
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function find($id) 
     {
@@ -77,8 +77,8 @@  discard block
 block discarded – undo
      * @param  string  $query   The search text.
      * @param  integer $perPage Number of rows per page default 15.
      * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -94,8 +94,8 @@  discard block
 block discarded – undo
      * 
      * @param  \Illuminate\Http\Request  $request
      * @param  string  $sortBy The name of the column to sort by.
-     * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc   Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function findby(Request $request, $sortBy = 'created_at', $desc = 1) 
     {
@@ -110,7 +110,7 @@  discard block
 block discarded – undo
      * condition.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function first(Request $request) 
     {
@@ -125,8 +125,8 @@  discard block
 block discarded – undo
      * 
      * @param  integer $perPage Number of rows per page default 15.
      * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -143,8 +143,8 @@  discard block
 block discarded – undo
      * @param  \Illuminate\Http\Request  $request
      * @param  integer $perPage Number of rows per page default 15.
      * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -158,7 +158,7 @@  discard block
 block discarded – undo
      * Save the given model to storage.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function save(Request $request) 
     {
@@ -191,7 +191,7 @@  discard block
 block discarded – undo
      * Delete by the given id from storage.
      * 
      * @param  integer $id Id of the deleted model.
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function delete($id) 
     {
@@ -207,8 +207,8 @@  discard block
 block discarded – undo
      * @param  \Illuminate\Http\Request  $request
      * @param  integer $perPage Number of rows per page default 15.
      * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse
      */
     public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -219,7 +219,7 @@  discard block
 block discarded – undo
      * Restore the deleted model.
      * 
      * @param  integer $id Id of the restored model.
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function restore($id) 
     {

Please login to merge, or discard this patch.

		@@ -1,6 +1,5 @@
		block discarded – undo
1	1	<?php namespace App\Modules\V1\Acl;
2	2
3		-use Illuminate\Database\Eloquent\Model;
4	3	use App\User;
5	4	use Illuminate\Database\Eloquent\SoftDeletes;
6	5

		@@ -32,7 +32,7 @@ discard block
		block discarded – undo
32	32	*
33	33	* @param array $relations
34	34	* @param string $sortBy
35		- * @param boolean $desc
	35	+ * @param integer $desc
36	36	* @param array $columns
37	37	* @return collection
38	38	*/
		@@ -50,7 +50,7 @@ discard block
		block discarded – undo
50	50	* @param integer $perPage
51	51	* @param array $relations
52	52	* @param string $sortBy
53		- * @param boolean $desc
	53	+ * @param integer $desc
54	54	* @param array $columns
55	55	* @return collection
56	56	*/
		@@ -139,7 +139,7 @@ discard block
		block discarded – undo
139	139	* @param integer $perPage
140	140	* @param array $relations
141	141	* @param string $sortBy
142		- * @param boolean $desc
	142	+ * @param integer $desc
143	143	* @param array $columns
144	144	* @return collection
145	145	*/
		@@ -157,7 +157,7 @@ discard block
		block discarded – undo
157	157	* @param integer $perPage
158	158	* @param array $relations
159	159	* @param string $sortBy
160		- * @param boolean $desc
	160	+ * @param integer $desc
161	161	* @param array $columns
162	162	* @return collection
163	163	*/
		@@ -418,7 +418,7 @@ discard block
		block discarded – undo
418	418	* Update record in the storage based on the given
419	419	* condition.
420	420	*
421		- * @param var $value condition value
	421	+ * @param boolean $value condition value
422	422	* @param array $data
423	423	* @param string $attribute condition column name
424	424	* @return void
		@@ -479,7 +479,7 @@ discard block
		block discarded – undo
479	479	* id.
480	480	*
481	481	* @param integer $id
482		- * @param array $relations
	482	+ * @param string[] $relations
483	483	* @param array $columns
484	484	* @return object
485	485	*/
		@@ -495,7 +495,7 @@ discard block
		block discarded – undo
495	495	* @param array $conditions array of conditions
496	496	* @param array $relations
497	497	* @param string $sortBy
498		- * @param boolean $desc
	498	+ * @param integer $desc
499	499	* @param array $columns
500	500	* @return collection
501	501	*/
		@@ -527,7 +527,7 @@ discard block
		block discarded – undo
527	527	* @param array $conditions array of conditions
528	528	* @param integer $perPage
529	529	* @param string $sortBy
530		- * @param boolean $desc
	530	+ * @param integer $desc
531	531	* @param array $columns
532	532	* @return collection
533	533	*/

		@@ -91,7 +91,7 @@ discard block
		block discarded – undo
91	91	* Generate headers for the given route.
92	92	*
93	93	* @param array &$route
94		- * @param object $reflectionClass
	94	+ * @param \ReflectionClass $reflectionClass
95	95	* @param string $method
96	96	* @param array $skipLoginCheck
97	97	* @return void
		@@ -118,6 +118,7 @@ discard block
		block discarded – undo
118	118	*
119	119	* @param array &$route
120	120	* @param object $reflectionMethod]
	121	+ * @param \ReflectionMethod $reflectionMethod
121	122	* @return void
122	123	*/
123	124	protected function processDocBlock(&$route, $reflectionMethod)
		@@ -140,7 +141,7 @@ discard block
		block discarded – undo
140	141	* Generate post body for the given route.
141	142	*
142	143	* @param array &$route
143		- * @param object $reflectionMethod
	144	+ * @param \ReflectionMethod $reflectionMethod
144	145	* @param array $validationRules
145	146	* @return void
146	147	*/

		@@ -45,8 +45,8 @@ discard block
		block discarded – undo
45	45	* Fetch all records with relations from storage.
46	46	*
47	47	* @param string $sortBy The name of the column to sort by.
48		- * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc).
49		- * @return \Illuminate\Http\Response
	48	+ * @param integer $desc Sort ascending or descinding (1: desc, 0: asc).
	49	+ * @return \Illuminate\Http\JsonResponse\|null
50	50	*/
51	51	public function index($sortBy = 'created_at', $desc = 1)
52	52	{
		@@ -60,7 +60,7 @@ discard block
		block discarded – undo
60	60	* Fetch the single object with relations from storage.
61	61	*
62	62	* @param integer $id Id of the requested model.
63		- * @return \Illuminate\Http\Response
	63	+ * @return \Illuminate\Http\JsonResponse\|null
64	64	*/
65	65	public function find($id)
66	66	{
		@@ -77,8 +77,8 @@ discard block
		block discarded – undo
77	77	* @param string $query The search text.
78	78	* @param integer $perPage Number of rows per page default 15.
79	79	* @param string $sortBy The name of the column to sort by.
80		- * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc).
81		- * @return \Illuminate\Http\Response
	80	+ * @param integer $desc Sort ascending or descinding (1: desc, 0: asc).
	81	+ * @return \Illuminate\Http\JsonResponse\|null
82	82	*/
83	83	public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1)
84	84	{
		@@ -94,8 +94,8 @@ discard block
		block discarded – undo
94	94	*
95	95	* @param \Illuminate\Http\Request $request
96	96	* @param string $sortBy The name of the column to sort by.
97		- * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc).
98		- * @return \Illuminate\Http\Response
	97	+ * @param integer $desc Sort ascending or descinding (1: desc, 0: asc).
	98	+ * @return \Illuminate\Http\JsonResponse\|null
99	99	*/
100	100	public function findby(Request $request, $sortBy = 'created_at', $desc = 1)
101	101	{
		@@ -110,7 +110,7 @@ discard block
		block discarded – undo
110	110	* condition.
111	111	*
112	112	* @param \Illuminate\Http\Request $request
113		- * @return \Illuminate\Http\Response
	113	+ * @return \Illuminate\Http\JsonResponse\|null
114	114	*/
115	115	public function first(Request $request)
116	116	{
		@@ -125,8 +125,8 @@ discard block
		block discarded – undo
125	125	*
126	126	* @param integer $perPage Number of rows per page default 15.
127	127	* @param string $sortBy The name of the column to sort by.
128		- * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc).
129		- * @return \Illuminate\Http\Response
	128	+ * @param integer $desc Sort ascending or descinding (1: desc, 0: asc).
	129	+ * @return \Illuminate\Http\JsonResponse\|null
130	130	*/
131	131	public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1)
132	132	{
		@@ -143,8 +143,8 @@ discard block
		block discarded – undo
143	143	* @param \Illuminate\Http\Request $request
144	144	* @param integer $perPage Number of rows per page default 15.
145	145	* @param string $sortBy The name of the column to sort by.
146		- * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc).
147		- * @return \Illuminate\Http\Response
	146	+ * @param integer $desc Sort ascending or descinding (1: desc, 0: asc).
	147	+ * @return \Illuminate\Http\JsonResponse\|null
148	148	*/
149	149	public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1)
150	150	{
		@@ -158,7 +158,7 @@ discard block
		block discarded – undo
158	158	* Save the given model to storage.
159	159	*
160	160	* @param \Illuminate\Http\Request $request
161		- * @return \Illuminate\Http\Response
	161	+ * @return \Illuminate\Http\JsonResponse\|null
162	162	*/
163	163	public function save(Request $request)
164	164	{
		@@ -191,7 +191,7 @@ discard block
		block discarded – undo
191	191	* Delete by the given id from storage.
192	192	*
193	193	* @param integer $id Id of the deleted model.
194		- * @return \Illuminate\Http\Response
	194	+ * @return \Illuminate\Http\JsonResponse\|null
195	195	*/
196	196	public function delete($id)
197	197	{
		@@ -207,8 +207,8 @@ discard block
		block discarded – undo
207	207	* @param \Illuminate\Http\Request $request
208	208	* @param integer $perPage Number of rows per page default 15.
209	209	* @param string $sortBy The name of the column to sort by.
210		- * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc).
211		- * @return \Illuminate\Http\Response
	210	+ * @param integer $desc Sort ascending or descinding (1: desc, 0: asc).
	211	+ * @return \Illuminate\Http\JsonResponse
212	212	*/
213	213	public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1)
214	214	{
		@@ -219,7 +219,7 @@ discard block
		block discarded – undo
219	219	* Restore the deleted model.
220	220	*
221	221	* @param integer $id Id of the restored model.
222		- * @return \Illuminate\Http\Response
	222	+ * @return \Illuminate\Http\JsonResponse\|null
223	223	*/
224	224	public function restore($id)
225	225	{

SherifElfadaly / Laravel-Api-Skeleton

Push — master ( 5c1ad5...6c0ec9 )

Status

Category

Unused Use Statements -1 removed lines patch added patch discarded remove patch

Doc Comments +8 added lines, -8 removed lines patch added patch discarded remove patch

Doc Comments +3 added lines, -2 removed lines patch added patch discarded remove patch

Doc Comments +17 added lines, -17 removed lines patch added patch discarded remove patch