From f74187f8c731a561489a5ea5a56a5c8726a4df87 Mon Sep 17 00:00:00 2001 From: Aleksei Lebedev <1329824+LastDragon-ru@users.noreply.github.com> Date: Fri, 29 Nov 2024 11:09:17 +0400 Subject: [PATCH 1/3] feat(documentator): Ability to specify filename patterns for `include:document-list` instruction (`LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeDocumentList::$include`). --- .../documentator/docs/Commands/preprocess.md | 2 ++ .../IncludeDocumentList/Instruction.php | 7 ++-- .../IncludeDocumentList/InstructionTest.php | 34 +++++++++++++++++++ .../IncludeDocumentList/Parameters.php | 10 ++++++ 4 files changed, 51 insertions(+), 2 deletions(-) diff --git a/packages/documentator/docs/Commands/preprocess.md b/packages/documentator/docs/Commands/preprocess.md index f5cba05c..acb9ad43 100644 --- a/packages/documentator/docs/Commands/preprocess.md +++ b/packages/documentator/docs/Commands/preprocess.md @@ -80,6 +80,8 @@ which will be replaced to FQCN (if possible). Other tags are ignored. * `null`: ` + 1` * `int`: explicit level (`1-6`) * `0`: `` + * `include`: `array|string|null` = `null` - [Rules which filenames must match](https://symfony.com/doc/current/components/finder.html#path) + (only Markdown documents will be listed). Returns the list of `*.md` files in the `` directory. Each file must have `# Header` as the first construction. The first paragraph diff --git a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/Instruction.php b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/Instruction.php index e240ca86..a2028df4 100644 --- a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/Instruction.php +++ b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/Instruction.php @@ -20,6 +20,7 @@ use League\CommonMark\Extension\CommonMark\Node\Block\Heading; use Override; +use function array_filter; use function max; use function min; use function usort; @@ -60,9 +61,11 @@ public static function getParameters(): string { */ #[Override] public function __invoke(Context $context, string $target, mixed $parameters): Generator { - $documents = []; - $iterator = Cast::to(Iterator::class, yield new FileIterator($target, '*.md', $parameters->depth)); $self = $context->file->getPath(); + $patterns = array_filter((array) $parameters->include, static fn ($s) => $s !== ''); + $patterns = $patterns === [] ? '*.md' : $patterns; + $iterator = Cast::to(Iterator::class, yield new FileIterator($target, $patterns, $parameters->depth)); + $documents = []; foreach ($iterator as $file) { // Prepare diff --git a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/InstructionTest.php b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/InstructionTest.php index d73766cb..319b6b7c 100644 --- a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/InstructionTest.php +++ b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/InstructionTest.php @@ -136,6 +136,26 @@ public static function dataProviderInvoke(): array { [include:document-list]: . ({"depth": null, "order": "Desc"}) MARKDOWN, ], + 'Depth is array' => [ + <<<'MARKDOWN' + # [Nested A]() + + Summary [text](../Document.md). + + [Read more](). + + # [Nested B]() + + Summary [text](../Document.md). + + [Read more](). + + MARKDOWN, + 'nested/Document.md', + <<<'MARKDOWN' + [include:document-list]: . ({"depth": ["> 0", "< 2"]}) + MARKDOWN, + ], 'Level `null`' => [ <<<'MARKDOWN' ## [`<` Document B `>`]() @@ -208,6 +228,20 @@ public static function dataProviderInvoke(): array { [include:document-list]: ./ ({"level": 4}) MARKDOWN, ], + 'Include' => [ + <<<'MARKDOWN' + # [Nested B]() + + Summary [text](../Document.md). + + [Read more](). + + MARKDOWN, + 'nested/Document.md', + <<<'MARKDOWN' + [include:document-list]: . ({"include": "*B.md", "depth": null}) + MARKDOWN, + ], ]; } // diff --git a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/Parameters.php b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/Parameters.php index 2f930de3..10ab16fe 100644 --- a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/Parameters.php +++ b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/Parameters.php @@ -19,6 +19,7 @@ public function __construct( * (eg the `0` means no nested directories, the `null` removes limits). * * @see Finder::depth() + * * @var array|string|int|null */ public readonly array|string|int|null $depth = 0, @@ -41,6 +42,15 @@ public function __construct( * * `0`: `` */ public readonly ?int $level = null, + /** + * [Rules which filenames must match](https://symfony.com/doc/current/components/finder.html#path) + * (only Markdown documents will be listed). + * + * @see Finder::path() + * + * @var array|string|null + */ + public readonly array|string|null $include = null, ) { // empty } From fc1048b9c139771b2668d2ad0497d33bbeb45a54 Mon Sep 17 00:00:00 2001 From: Aleksei Lebedev <1329824+LastDragon-ru@users.noreply.github.com> Date: Fri, 29 Nov 2024 11:26:20 +0400 Subject: [PATCH 2/3] deprecate(documentator): `include:package-list` instruction, the `include:document-list` can be used instead. --- .markdownlint-cli2.yaml | 1 - README.md | 28 +++++++++---------- UPGRADE.md | 20 ------------- .../PackageComposerJsonIsMissing.php | 3 ++ .../Exceptions/PackageReadmeIsEmpty.php | 3 ++ .../IncludePackageList/Instruction.php | 9 ++++++ .../IncludePackageList/InstructionTest.php | 1 + .../IncludePackageList/Parameters.php | 3 ++ 8 files changed, 33 insertions(+), 35 deletions(-) diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml index b1678702..9588059b 100644 --- a/.markdownlint-cli2.yaml +++ b/.markdownlint-cli2.yaml @@ -283,7 +283,6 @@ config: "include:example", "include:artisan", "include:file", - "include:package-list", "include:template", "include:docblock", "include:graphql-directive" diff --git a/README.md b/README.md index 578457c3..aa544e3c 100644 --- a/README.md +++ b/README.md @@ -42,75 +42,75 @@ composer require lastdragon-ru/lara-asp- | 🐝 | Package intended to use in dev. | |:--:|---------------------------------| -[include:package-list]: ./packages -[//]: # (start: preprocess/aeb862adf9d9852d) +[include:document-list]: ./packages ({"include": "README.md", "depth": 1}) +[//]: # (start: preprocess/46988a763d0c2d97) [//]: # (warning: Generated automatically. Do not edit.) -## (Laravel) Core +## [(Laravel) Core]() This package contains useful utilities and classes. [Read more](). -## (Laravel) Documentator +## [(Laravel) Documentator]() This package provides various utilities for documentation generation such as Markdown Preprocessor, Requirements Dumper and more. [Read more](). -## (Laravel) Eloquent Helpers +## [(Laravel) Eloquent Helpers]() This package contains useful extensions and mixins for [Eloquent](https://laravel.com/docs/eloquent). [Read more](). -## (Laravel) GraphQL Extensions for Lighthouse +## [(Laravel) GraphQL Extensions for Lighthouse]() This package provides highly powerful [`@searchBy`](packages/graphql/docs/Directives/@searchBy.md), [`@sortBy`](packages/graphql/docs/Directives/@sortBy.md), [`@stream`](packages/graphql/docs/Directives/@stream.md) directives for [lighthouse-php](https://lighthouse-php.com/). The [`@searchBy`](packages/graphql/docs/Directives/@searchBy.md) directive provides basic conditions like `=`, `>`, `<`, etc, relations, `not ()`, enums, and custom operators support. All are strictly typed so you no need to use `Mixed` type anymore. The [`@sortBy`](packages/graphql/docs/Directives/@sortBy.md) is not only about standard sorting by columns but also allows use relations. 😎 [Read more](). -## (Laravel) Intl Formatter +## [(Laravel) Intl Formatter]() This package provides a customizable wrapper around [Intl](https://www.php.net/manual/en/book.intl) formatters to use it inside Laravel application. And also allows defining own. [Read more](). -## (Laravel) Raw SQL Migrator/Seeder +## [(Laravel) Raw SQL Migrator/Seeder]() This package improves standard Laravel migrations to add support for raw SQL files during migration and seeding. So you can easily use your favorite visual tool for database development like [MySQL Workbench](https://www.mysql.com/products/workbench/) with Laravel 🥳 [Read more](). -## (Laravel) SPA Helpers +## [(Laravel) SPA Helpers]() [Read more](). -## (Laravel) Symfony Serializer +## [(Laravel) Symfony Serializer]() This package provides a customizable wrapper around the [Symfony Serializer Component](https://symfony.com/doc/current/components/serializer.html) to use it inside Laravel application. [Read more](). -## (Laravel) Testing Helpers 🐝 +## [(Laravel) Testing Helpers 🐝]() This package provides various useful asserts for [PHPUnit](https://phpunit.de/) and better solution for HTTP tests - testing HTTP response has never been so easy! And this not only about `TestResponse` but any PSR response 😎 [Read more](). -## Dev 🐝 +## [Dev 🐝]() Various internal tools and helpers to develop the package itself. [Read more](). -## GraphQL Printer +## [GraphQL Printer]() Independent (from Laravel and Lighthouse) package that allow you to print GraphQL Schema and Queries in highly customized way eg you can choose indent size, print only used/wanted/all types, print only one type, print used/wanted/all directives ([it is not possible with standard printer](https://github.com/webonyx/graphql-php/issues/552)) and even check which types/directives are used in the Schema/Query. [Read more](). -[//]: # (end: preprocess/aeb862adf9d9852d) +[//]: # (end: preprocess/46988a763d0c2d97) # Upgrading diff --git a/UPGRADE.md b/UPGRADE.md index 12d90a6f..0452671f 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -27,26 +27,6 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases) [//]: # (end: preprocess/8aaed7c3a55b57f9) -# Packages - -[include:package-list]: ./packages ({"template": "upgradable"}) -[//]: # (start: preprocess/54260d8bcef12cc3) -[//]: # (warning: Generated automatically. Do not edit.) - -* [(Laravel) Core]() -* [(Laravel) Documentator]() -* [(Laravel) Eloquent Helpers]() -* [(Laravel) GraphQL Extensions for Lighthouse]() -* [(Laravel) Intl Formatter]() -* [(Laravel) Raw SQL Migrator/Seeder]() -* [(Laravel) SPA Helpers]() -* [(Laravel) Symfony Serializer]() -* [(Laravel) Testing Helpers 🐝]() -* [Dev 🐝]() -* [GraphQL Printer]() - -[//]: # (end: preprocess/54260d8bcef12cc3) - # Upgrade from v5 * [ ] Installation of the root `lastdragon-ru/lara-asp` package is not recommended anymore 🤝 diff --git a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Exceptions/PackageComposerJsonIsMissing.php b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Exceptions/PackageComposerJsonIsMissing.php index e297f593..5f51e9fe 100644 --- a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Exceptions/PackageComposerJsonIsMissing.php +++ b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Exceptions/PackageComposerJsonIsMissing.php @@ -9,6 +9,9 @@ use function sprintf; +/** + * @deprecated %{VERSION} + */ class PackageComposerJsonIsMissing extends InstructionFailed { public function __construct( Context $context, diff --git a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Exceptions/PackageReadmeIsEmpty.php b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Exceptions/PackageReadmeIsEmpty.php index 7e19abe0..f5f4c038 100644 --- a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Exceptions/PackageReadmeIsEmpty.php +++ b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Exceptions/PackageReadmeIsEmpty.php @@ -10,6 +10,9 @@ use function sprintf; +/** + * @deprecated %{VERSION} + */ class PackageReadmeIsEmpty extends InstructionFailed { public function __construct( Context $context, diff --git a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Instruction.php b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Instruction.php index 50bc8b0a..a8b7a69c 100644 --- a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Instruction.php +++ b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Instruction.php @@ -5,6 +5,7 @@ use Generator; use Iterator; use LastDragon_ru\LaraASP\Core\Utils\Cast; +use LastDragon_ru\LaraASP\Documentator\Package; use LastDragon_ru\LaraASP\Documentator\PackageViewer; use LastDragon_ru\LaraASP\Documentator\Processor\Contracts\Dependency; use LastDragon_ru\LaraASP\Documentator\Processor\Dependencies\DirectoryIterator; @@ -16,18 +17,26 @@ use LastDragon_ru\LaraASP\Documentator\Processor\Metadata\Markdown; use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Context; use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Instruction as InstructionContract; +use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeDocumentList\Instruction as IncludeDocumentList; use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludePackageList\Exceptions\PackageComposerJsonIsMissing; use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludePackageList\Exceptions\PackageReadmeIsEmpty; use LastDragon_ru\LaraASP\Documentator\Utils\Sorter; use LastDragon_ru\LaraASP\Documentator\Utils\Text; use Override; +use function trigger_deprecation; use function usort; +// phpcs:disable PSR1.Files.SideEffects + +trigger_deprecation(Package::Name, '%{VERSION}', 'Please use `%s` instead.', IncludeDocumentList::class); + /** * Generates package list from `` directory. The readme file will be * used to determine package name and summary. * + * @deprecated %{VERSION} Please use {@see IncludeDocumentList} instead. + * * @implements InstructionContract */ class Instruction implements InstructionContract { diff --git a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/InstructionTest.php b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/InstructionTest.php index 5218ac10..e87ce37b 100644 --- a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/InstructionTest.php +++ b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/InstructionTest.php @@ -20,6 +20,7 @@ use PHPUnit\Framework\Attributes\DataProvider; /** + * @deprecated %{VERSION} * @internal */ #[CoversClass(Instruction::class)] diff --git a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Parameters.php b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Parameters.php index 34109970..d90f2d00 100644 --- a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Parameters.php +++ b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludePackageList/Parameters.php @@ -6,6 +6,9 @@ use LastDragon_ru\LaraASP\Documentator\Utils\SortOrder; use LastDragon_ru\LaraASP\Serializer\Contracts\Serializable; +/** + * @deprecated %{VERSION} + */ class Parameters implements ParametersContract, Serializable { public function __construct( /** From cd2ac7d57f4170abb4d7e52b4a183727d3e9ea6b Mon Sep 17 00:00:00 2001 From: Aleksei Lebedev <1329824+LastDragon-ru@users.noreply.github.com> Date: Fri, 29 Nov 2024 12:01:11 +0400 Subject: [PATCH 3/3] feat(documentator): Deprecation mark output in generated help of `lara-asp-documentator:preprocess` command. --- .../documentator/docs/Commands/preprocess.md | 16 ++++---- .../documentator/src/Commands/Preprocess.php | 41 ++++++++++++++----- .../src/Commands/PreprocessTest.php | 16 ++++---- 3 files changed, 47 insertions(+), 26 deletions(-) diff --git a/packages/documentator/docs/Commands/preprocess.md b/packages/documentator/docs/Commands/preprocess.md index acb9ad43..37c9ee36 100644 --- a/packages/documentator/docs/Commands/preprocess.md +++ b/packages/documentator/docs/Commands/preprocess.md @@ -59,8 +59,8 @@ run with default/normal level if it is not specified in its arguments. * `` - File path. * `` - additional parameters - * `summary`: `bool` = `true` - Include the class summary? * `description`: `bool` = `true` - Include the class description? + * `summary`: `bool` = `true` - Include the class summary? Includes the docblock of the first PHP class/interface/trait/enum/etc from `` file. Inline tags include as is except `@see`/`@link` @@ -72,16 +72,16 @@ which will be replaced to FQCN (if possible). Other tags are ignored. * `` - additional parameters * `depth`: `array|string|int|null` = `0` - [Directory Depth](https://symfony.com/doc/current/components/finder.html#directory-depth) (eg the `0` means no nested directories, the `null` removes limits). - * `template`: `string` = `'default'` - Blade template. The documents passed in the `$data` ([`Data`][code-links/84d51020d324cc16]) - variable. Also, be careful with leading whitespaces. - * `order`: [`SortOrder`][code-links/7e5c66e8748c6ff8] = [`SortOrder::Asc`][code-links/08e0648f66e2d1a5] - Sort order. + * `include`: `array|string|null` = `null` - [Rules which filenames must match](https://symfony.com/doc/current/components/finder.html#path) + (only Markdown documents will be listed). * `level`: `?int` = `null` - Headings level. Possible values are * `null`: ` + 1` * `int`: explicit level (`1-6`) * `0`: `` - * `include`: `array|string|null` = `null` - [Rules which filenames must match](https://symfony.com/doc/current/components/finder.html#path) - (only Markdown documents will be listed). + * `order`: [`SortOrder`][code-links/7e5c66e8748c6ff8] = [`SortOrder::Asc`][code-links/08e0648f66e2d1a5] - Sort order. + * `template`: `string` = `'default'` - Blade template. The documents passed in the `$data` ([`Data`][code-links/84d51020d324cc16]) + variable. Also, be careful with leading whitespaces. Returns the list of `*.md` files in the `` directory. Each file must have `# Header` as the first construction. The first paragraph @@ -120,12 +120,12 @@ Includes the `` file. Includes the definition of the directive as a Markdown code block. -#### `[include:package-list]: ` +#### `[include:package-list]: ` 💀 * `` - Directory path. * `` - additional parameters - * `template`: `string` = `'default'` - Blade template. * `order`: [`SortOrder`][code-links/7e5c66e8748c6ff8] = [`SortOrder::Asc`][code-links/08e0648f66e2d1a5] - Sort order. + * `template`: `string` = `'default'` - Blade template. Generates package list from `` directory. The readme file will be used to determine package name and summary. diff --git a/packages/documentator/src/Commands/Preprocess.php b/packages/documentator/src/Commands/Preprocess.php index 137a82e9..18885888 100644 --- a/packages/documentator/src/Commands/Preprocess.php +++ b/packages/documentator/src/Commands/Preprocess.php @@ -17,6 +17,7 @@ use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Instruction; use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Parameters; use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Task as PreprocessTask; +use LastDragon_ru\LaraASP\Documentator\Utils\PhpDoc; use LastDragon_ru\LaraASP\Documentator\Utils\PhpDocumentFactory; use LastDragon_ru\LaraASP\Documentator\Utils\Text; use LastDragon_ru\LaraASP\Formatter\Formatter; @@ -54,7 +55,8 @@ description: 'Perform one or more task on the file.', )] class Preprocess extends Command { - public const Name = Package::Name.':preprocess'; + public const Name = Package::Name.':preprocess'; + private const DeprecationMarker = '💀'; /** * @phpcsSuppress SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint @@ -133,10 +135,11 @@ protected function getProcessedHelpTasks(int $level): string { $description = trim($this->getProcessedHelpTaskDescription($task, $level + 1)); $description = $description !== '' ? $description : $default; $extensions = '`'.implode('`, `', $task::getExtensions()).'`'; + $deprecated = $this->getDeprecatedMark(new ReflectionClass($task)); $title = trim((string) $this->getProcessedHelpTaskTitle($task)); $title = $title !== '' ? $title : "Task №{$index}"; $help .= <<getDocBlock($class, null, $level + 1); - $target = trim((string) $this->getProcessedHelpTaskPreprocessInstructionTarget($instruction, 'target', 2)); - $target = $target !== '' ? $target : '_No description provided_.'; - $params = $this->getProcessedHelpTaskPreprocessParameters($instruction, 'target', 2); + $class = new ReflectionClass($instruction); + $name = $instruction::getName(); + $desc = $this->getDocBlock($class, null, $level + 1); + $target = trim( + (string) $this->getProcessedHelpTaskPreprocessInstructionTarget($instruction, 'target', 2), + ); + $target = $target !== '' ? $target : '_No description provided_.'; + $params = $this->getProcessedHelpTaskPreprocessParameters($instruction, 'target', 2); + $deprecated = $this->getDeprecatedMark($class); if ($params !== null) { $help[$name] = rtrim( << ` + {$heading} `[{$name}]: `{$deprecated} * `` - {$target} * `` - additional parameters @@ -193,7 +199,7 @@ protected function getProcessedHelpTaskPreprocessInstructions(PreprocessTask $ta } else { $help[$name] = rtrim( <<` + {$heading} `[{$name}]: `{$deprecated} * `` - {$target} @@ -288,6 +294,7 @@ protected function getProcessedHelpTaskPreprocessParameters( } // Add + $definition = $this->getDeprecatedMark($property).$definition; $description = trim($this->getDocBlock($property, $padding)); $description = $description !== '' ? $description : '_No description provided_.'; $parameters[trim($definition)] = $description; @@ -298,6 +305,9 @@ protected function getProcessedHelpTaskPreprocessParameters( return null; } + // Sort + ksort($parameters); + // Serialize $list = ''; @@ -346,4 +356,15 @@ private function getDocBlock( // Return return trim($help); } + + /** + * @param ReflectionClass|ReflectionProperty $object + */ + private function getDeprecatedMark(ReflectionClass|ReflectionProperty $object): string { + $comment = $object->getDocComment(); + $deprecated = $comment !== false && (new PhpDoc($comment))->isDeprecated(); + $deprecated = $deprecated ? ' '.self::DeprecationMarker : ''; + + return $deprecated; + } } diff --git a/packages/documentator/src/Commands/PreprocessTest.php b/packages/documentator/src/Commands/PreprocessTest.php index 69ad639f..a583b795 100644 --- a/packages/documentator/src/Commands/PreprocessTest.php +++ b/packages/documentator/src/Commands/PreprocessTest.php @@ -49,14 +49,14 @@ public function getProcessedHelpTaskPreprocessInstructions(PreprocessTask $task, Target target target target target target target target target target target target target target target target target target. * `` - additional parameters - * `publicPropertyWithoutDefaultValue`: `int` - Description. - * `publicPropertyWithDefaultValue`: `float` = `123.0` - _No description provided_. - * `publicPropertyEnumWithDefaultValue`: `LastDragon_ru\LaraASP\Documentator\Commands\PreprocessTest__Enum` = `LastDragon_ru\LaraASP\Documentator\Commands\PreprocessTest__Enum::B` - _No description provided_. - * `publicPromotedPropertyWithoutDefaultValue`: `int` - Description. * `publicPromotedPropertyWithDefaultValue`: `int` = `321` - Summary. Description description description description description description description description description. + * `publicPromotedPropertyWithoutDefaultValue`: `int` - Description. + * `publicPropertyEnumWithDefaultValue`: `LastDragon_ru\LaraASP\Documentator\Commands\PreprocessTest__Enum` = `LastDragon_ru\LaraASP\Documentator\Commands\PreprocessTest__Enum::B` - _No description provided_. + * `publicPropertyWithDefaultValue`: `float` = `123.0` - _No description provided_. + * `publicPropertyWithoutDefaultValue`: `int` - Description. Summary summary summary. @@ -130,14 +130,14 @@ public function getProcessedHelpTaskPreprocessParameters( self::assertEquals( <<<'MARKDOWN' - * `publicPropertyWithoutDefaultValue`: `int` - Description. - * `publicPropertyWithDefaultValue`: `float` = `123.0` - _No description provided_. - * `publicPropertyEnumWithDefaultValue`: `LastDragon_ru\LaraASP\Documentator\Commands\PreprocessTest__Enum` = `LastDragon_ru\LaraASP\Documentator\Commands\PreprocessTest__Enum::B` - _No description provided_. - * `publicPromotedPropertyWithoutDefaultValue`: `int` - Description. * `publicPromotedPropertyWithDefaultValue`: `int` = `321` - Summary. Description description description description description description description description description. + * `publicPromotedPropertyWithoutDefaultValue`: `int` - Description. + * `publicPropertyEnumWithDefaultValue`: `LastDragon_ru\LaraASP\Documentator\Commands\PreprocessTest__Enum` = `LastDragon_ru\LaraASP\Documentator\Commands\PreprocessTest__Enum::B` - _No description provided_. + * `publicPropertyWithDefaultValue`: `float` = `123.0` - _No description provided_. + * `publicPropertyWithoutDefaultValue`: `int` - Description. MARKDOWN, $command->getProcessedHelpTaskPreprocessParameters( PreprocessTest__Instruction::class,