From 67c00c09789080c64d134e48e5689a82b94348f7 Mon Sep 17 00:00:00 2001 From: Benedikt Franke Date: Fri, 12 Jul 2024 15:58:21 +0200 Subject: [PATCH] Improve config file (#1564) * Improve config file - Terminate all descriptions with a dot . - Update outdated descriptions - Add missing examples * Fix capitalizations --- config/ide-helper.php | 50 +++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/config/ide-helper.php b/config/ide-helper.php index e3bdc574c..2e5be0153 100644 --- a/config/ide-helper.php +++ b/config/ide-helper.php @@ -4,21 +4,21 @@ /* |-------------------------------------------------------------------------- - | Filename & Format + | Filename |-------------------------------------------------------------------------- | - | The default filename + | The default filename. | */ - 'filename' => '_ide_helper.php', + 'filename' => '_ide_helper.php', /* |-------------------------------------------------------------------------- | Models filename |-------------------------------------------------------------------------- | - | The default filename for the models helper file + | The default filename for the models helper file. | */ @@ -26,7 +26,7 @@ /* |-------------------------------------------------------------------------- - | Where to write the PhpStorm specific meta file + | PhpStorm meta filename |-------------------------------------------------------------------------- | | PhpStorm also supports the directory `.phpstorm.meta.php/` with arbitrary @@ -41,7 +41,7 @@ | Fluent helpers |-------------------------------------------------------------------------- | - | Set to true to generate commonly used Fluent methods + | Set to true to generate commonly used Fluent methods. | */ @@ -49,7 +49,7 @@ /* |-------------------------------------------------------------------------- - | Factory Builders + | Factory builders |-------------------------------------------------------------------------- | | Set to true to generate factory generators for better factory() @@ -63,10 +63,10 @@ /* |-------------------------------------------------------------------------- - | Write Model Magic methods + | Write model magic methods |-------------------------------------------------------------------------- | - | Set to false to disable write magic methods of model + | Set to false to disable write magic methods of model. | */ @@ -74,10 +74,10 @@ /* |-------------------------------------------------------------------------- - | Write Model External Eloquent Builder methods + | Write model external Eloquent builder methods |-------------------------------------------------------------------------- | - | Set to false to disable write external eloquent builder methods + | Set to false to disable write external Eloquent builder methods. | */ @@ -85,7 +85,7 @@ /* |-------------------------------------------------------------------------- - | Write Model relation count properties + | Write model relation count properties |-------------------------------------------------------------------------- | | Set to false to disable writing of relation count properties to model DocBlocks. @@ -96,11 +96,11 @@ /* |-------------------------------------------------------------------------- - | Write Eloquent Model Mixins + | Write Eloquent model mixins |-------------------------------------------------------------------------- | | This will add the necessary DocBlock mixins to the model class - | contained in the Laravel Framework. This helps the IDE with + | contained in the Laravel framework. This helps the IDE with | auto-completion. | | Please be aware that this setting changes a file within the /vendor directory. @@ -134,7 +134,7 @@ | for models. | | glob patterns are supported to easier reach models in sub-directories, - | e.g. `app/Services/* /Models` (without the space) + | e.g. `app/Services/* /Models` (without the space). | */ @@ -152,7 +152,7 @@ */ 'ignored_models' => [ - + // App\MyModel::class, ], /* @@ -160,7 +160,7 @@ | Models hooks |-------------------------------------------------------------------------- | - | Define which hook classes you want to run for models to add custom information + | Define which hook classes you want to run for models to add custom information. | | Hooks should implement Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface. | @@ -175,7 +175,7 @@ | Extra classes |-------------------------------------------------------------------------- | - | These implementations are not really extended, but called with magic functions + | These implementations are not really extended, but called with magic functions. | */ @@ -197,7 +197,7 @@ */ 'interfaces' => [ - + // App\MyInterface::class => App\MyImplementation::class, ], /* @@ -228,7 +228,7 @@ /* |-------------------------------------------------------------------------- - | Property Casts + | Property casts |-------------------------------------------------------------------------- | | Cast the given "real type" to the given "type". @@ -255,9 +255,9 @@ | Force FQN usage |-------------------------------------------------------------------------- | - | Use the fully qualified (class) name in docBlock, - | event if class exists in a given file - | or there is an import (use className) of a given class + | Use the fully qualified (class) name in DocBlocks, + | even if the class exists in the same namespace + | or there is an import (use className) of the class. | */ 'force_fqn' => false, @@ -279,8 +279,8 @@ |-------------------------------------------------------------------------- | | Sometimes it's needed to create custom relation types. The key of the array - | is the Relationship Method name. The value of the array is the canonical class - | name of the Relationship, e.g. `'relationName' => RelationShipClass::class`. + | is the relationship method name. The value of the array is the fully-qualified + | class name of the relationship, e.g. `'relationName' => RelationShipClass::class`. | */ 'additional_relation_types' => [],