Merge branch 'cleanup'

Author: lkrms

.phive/phars.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="lkrms/pretty-php" version="^0.4.48" installed="0.4.87" location="./tools/pretty-php" copy="true"/>
-  <phar name="php-cs-fixer" version="^3.46.0" installed="3.68.0" location="./tools/php-cs-fixer" copy="true"/>
+  <phar name="lkrms/pretty-php" version="^0.4.48" installed="0.4.88" location="./tools/pretty-php" copy="true"/>
+  <phar name="php-cs-fixer" version="^3.46.0" installed="3.68.1" location="./tools/php-cs-fixer" copy="true"/>
   <phar name="salient-labs/changelog" version="^1.0.5" installed="1.0.8" location="./tools/changelog" copy="true"/>
 </phive>

.php-cs-fixer.dist.php

@@ -48,6 +48,7 @@
         'phpdoc_no_useless_inheritdoc' => true,
         'phpdoc_order' => ['order' => [
             'todo',
+            'see',
             'property',
             'property-read',
             'property-write',

src/Toolkit/Cli/CliCommand.php

@@ -1370,9 +1370,9 @@ final protected function isRunning(): bool
     /**
      * Set the command's return value / exit status
      *
-     * @return $this
-     *
      * @see CliCommand::run()
+     *
+     * @return $this
      */
     final protected function setExitStatus(int $status)
     {

src/Toolkit/Core/Concern/HasReadableProperties.php

@@ -15,9 +15,9 @@
  * - The existence of `_get<Property>()` makes `<Property>` readable, regardless
  *   of {@see Readable::getReadableProperties()}'s return value.
  *
- * @api
- *
  * @see Readable
+ *
+ * @api
  */
 trait HasReadableProperties
 {

src/Toolkit/Core/Concern/HasWritableProperties.php

@@ -15,9 +15,9 @@
  * - The existence of `_set<Property>()` makes `<Property>` writable, regardless
  *   of {@see Writable::getWritableProperties()}'s return value.
  *
- * @api
- *
  * @see Writable
+ *
+ * @api
  */
 trait HasWritableProperties
 {

src/Toolkit/Core/Concern/ProvidableTrait.php

@@ -16,10 +16,10 @@
 /**
  * Implements Providable to represent an external entity
  *
+ * @see Providable
+ *
  * @template TProvider of ProviderInterface
  * @template TContext of ProviderContextInterface
- *
- * @see Providable
  */
 trait ProvidableTrait
 {

src/Toolkit/Core/IntrospectionClass.php

@@ -661,13 +661,13 @@ function (int $a, int $b) use ($parents, $properties) {
      * Normalise strings if the class has a normaliser, otherwise return them
      * as-is
      *
+     * @see Normalisable::normalise()
+     *
      * @template T of string[]|string
      *
      * @param T $value
      * @param int-mask-of<NormaliserFlag::*> $flags
      * @return T
-     *
-     * @see Normalisable::normalise()
      */
     final public function maybeNormalise($value, int $flags = NormaliserFlag::GREEDY)
     {

src/Toolkit/Core/Introspector.php

@@ -176,13 +176,13 @@ final public function __get(string $name)
      * Normalise strings if the class has a normaliser, otherwise return them
      * as-is
      *
+     * @see Normalisable::normalise()
+     *
      * @template T of string[]|string
      *
      * @param T $value
      * @param int-mask-of<NormaliserFlag::*> $flags
      * @return T
-     *
-     * @see Normalisable::normalise()
      */
     final public function maybeNormalise($value, int $flags = NormaliserFlag::GREEDY)
     {

src/Toolkit/Core/IntrospectorKeyTargets.php

@@ -11,6 +11,8 @@
 /**
  * How to create or update an instance from an array
  *
+ * @see Introspector
+ *
  * @property-read array<string,int> $Parameters Key => constructor parameter index
  * @property-read array<string,true> $PassByRefParameters Key => `true`
  * @property-read array<string,true> $NotNullableParameters Key => `true`
@@ -22,8 +24,6 @@
  * @property-read array<TIntrospector::*_KEY,string> $CustomKeys Identifier => key
  * @property-read int $LastParameterIndex Index of the last constructor parameter to which array values are mapped
  *
- * @see Introspector
- *
  * @template TIntrospector of Introspector
  * @template TClass of object
  * @template TProvider of ProviderInterface

src/Toolkit/Sli/Command/Generate/AbstractGenerateCommand.php

@@ -753,9 +753,9 @@ protected function generate(array $innerBlocks = []): string
     /**
      * Generate a list of `use $fqcn[ as $alias];` statements
      *
-     * @return string[]
-     *
      * @see AbstractGenerateCommand::getFqcnAlias()
+     *
+     * @return string[]
      */
     protected function generateImports(): array
     {