From 8a0c31c1af66e345372837738d9b7588bcb7ee0b Mon Sep 17 00:00:00 2001 From: Aleksei Lebedev <1329824+LastDragon-ru@users.noreply.github.com> Date: Wed, 25 Sep 2024 10:38:51 +0400 Subject: [PATCH] More readable code-links list. --- .../src/Processor/Tasks/CodeLinks/Task.php | 2 +- .../InvokeMultipleGenerated~expected.md | 51 ++++++++++++------- .../Invoke/InvokeNoGenerated~expected.md | 51 ++++++++++++------- 3 files changed, 69 insertions(+), 35 deletions(-) diff --git a/packages/documentator/src/Processor/Tasks/CodeLinks/Task.php b/packages/documentator/src/Processor/Tasks/CodeLinks/Task.php index 3f1480de..2e5fd996 100644 --- a/packages/documentator/src/Processor/Tasks/CodeLinks/Task.php +++ b/packages/documentator/src/Processor/Tasks/CodeLinks/Task.php @@ -221,7 +221,7 @@ private function getChanges(Document $document, array $blocks, array $links): ar if ($target) { $referenceTitle = Utils::getLinkTitle($refsParentNode, $link); $referenceTarget = Utils::getLinkTarget($refsParentNode, (string) $target); - $references[$referenceTitle] = "[{$hash}]: {$referenceTarget} {$referenceTitle}"; + $references[$referenceTitle] = "[{$hash}]: {$referenceTarget}\n {$referenceTitle}"; } foreach ($token->nodes as $node) { diff --git a/packages/documentator/src/Processor/Tasks/CodeLinks/TaskTest/Invoke/InvokeMultipleGenerated~expected.md b/packages/documentator/src/Processor/Tasks/CodeLinks/TaskTest/Invoke/InvokeMultipleGenerated~expected.md index 0ff70766..c292d983 100644 --- a/packages/documentator/src/Processor/Tasks/CodeLinks/TaskTest/Invoke/InvokeMultipleGenerated~expected.md +++ b/packages/documentator/src/Processor/Tasks/CodeLinks/TaskTest/Invoke/InvokeMultipleGenerated~expected.md @@ -30,39 +30,56 @@ text [`💀B::B`][code-links/a69ac32d7aff4ecd]. [//]: # (start: code-links) [//]: # (warning: Generated automatically. Do not edit.) -[code-links/a48295a76761baf6]: A.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A" +[code-links/a48295a76761baf6]: A.php + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A" -[code-links/dac5489382576f25]: A/A.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A" +[code-links/dac5489382576f25]: A/A.php + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A" -[code-links/a6e3e81c5e81c205]: A/A.php#L12 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::$property" +[code-links/a6e3e81c5e81c205]: A/A.php#L12 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::$property" -[code-links/4c257d1cd2466598]: A/A.php#L9 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::A" +[code-links/4c257d1cd2466598]: A/A.php#L9 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::A" -[code-links/5dcd27cbfb8f1b9d]: A/A.php#L17-L22 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::method()" +[code-links/5dcd27cbfb8f1b9d]: A/A.php#L17-L22 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::method()" -[code-links/ec022a8fb0895161]: B/A.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A" +[code-links/ec022a8fb0895161]: B/A.php + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A" -[code-links/35cc9911dc30e23e]: B/A.php#L15 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::$property" +[code-links/35cc9911dc30e23e]: B/A.php#L15 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::$property" -[code-links/c18fdff7b584b292]: B/A.php#L9-L12 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::A" +[code-links/c18fdff7b584b292]: B/A.php#L9-L12 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::A" -[code-links/e3a93d722dcf6250]: B/A.php#L20-L25 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::method()" +[code-links/e3a93d722dcf6250]: B/A.php#L20-L25 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::method()" -[code-links/16591d639b61b142]: B/B.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B" +[code-links/16591d639b61b142]: B/B.php + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B" -[code-links/9889d47ea9b6ae82]: B/B.php#L15 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::$property" +[code-links/9889d47ea9b6ae82]: B/B.php#L15 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::$property" -[code-links/a69ac32d7aff4ecd]: B/B.php#L9-L12 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::B" +[code-links/a69ac32d7aff4ecd]: B/B.php#L9-L12 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::B" -[code-links/8343c4fede0f1f09]: B/B.php#L20-L22 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::method()" +[code-links/8343c4fede0f1f09]: B/B.php#L20-L22 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::method()" -[code-links/83a40c392c8376aa]: C/C.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C" +[code-links/83a40c392c8376aa]: C/C.php + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C" -[code-links/8881166beee50a03]: C/C.php#L13 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::$property" +[code-links/8881166beee50a03]: C/C.php#L13 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::$property" -[code-links/3422d2a08c15d182]: C/C.php#L10 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::C" +[code-links/3422d2a08c15d182]: C/C.php#L10 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::C" -[code-links/6369c3badb265e68]: C/C.php#L18-L20 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::method()" +[code-links/6369c3badb265e68]: C/C.php#L18-L20 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::method()" [//]: # (end: code-links) diff --git a/packages/documentator/src/Processor/Tasks/CodeLinks/TaskTest/Invoke/InvokeNoGenerated~expected.md b/packages/documentator/src/Processor/Tasks/CodeLinks/TaskTest/Invoke/InvokeNoGenerated~expected.md index 8c829893..de7ef368 100644 --- a/packages/documentator/src/Processor/Tasks/CodeLinks/TaskTest/Invoke/InvokeNoGenerated~expected.md +++ b/packages/documentator/src/Processor/Tasks/CodeLinks/TaskTest/Invoke/InvokeNoGenerated~expected.md @@ -44,38 +44,55 @@ Text text `LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest [//]: # (start: code-links) [//]: # (warning: Generated automatically. Do not edit.) -[code-links/a48295a76761baf6]: A.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A" +[code-links/a48295a76761baf6]: A.php + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A" -[code-links/dac5489382576f25]: A/A.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A" +[code-links/dac5489382576f25]: A/A.php + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A" -[code-links/a6e3e81c5e81c205]: A/A.php#L12 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::$property" +[code-links/a6e3e81c5e81c205]: A/A.php#L12 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::$property" -[code-links/4c257d1cd2466598]: A/A.php#L9 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::A" +[code-links/4c257d1cd2466598]: A/A.php#L9 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::A" -[code-links/5dcd27cbfb8f1b9d]: A/A.php#L17-L22 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::method()" +[code-links/5dcd27cbfb8f1b9d]: A/A.php#L17-L22 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\A\A::method()" -[code-links/ec022a8fb0895161]: B/A.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A" +[code-links/ec022a8fb0895161]: B/A.php + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A" -[code-links/35cc9911dc30e23e]: B/A.php#L15 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::$property" +[code-links/35cc9911dc30e23e]: B/A.php#L15 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::$property" -[code-links/c18fdff7b584b292]: B/A.php#L9-L12 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::A" +[code-links/c18fdff7b584b292]: B/A.php#L9-L12 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::A" -[code-links/e3a93d722dcf6250]: B/A.php#L20-L25 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::method()" +[code-links/e3a93d722dcf6250]: B/A.php#L20-L25 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\A::method()" -[code-links/16591d639b61b142]: B/B.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B" +[code-links/16591d639b61b142]: B/B.php + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B" -[code-links/9889d47ea9b6ae82]: B/B.php#L15 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::$property" +[code-links/9889d47ea9b6ae82]: B/B.php#L15 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::$property" -[code-links/a69ac32d7aff4ecd]: B/B.php#L9-L12 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::B" +[code-links/a69ac32d7aff4ecd]: B/B.php#L9-L12 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::B" -[code-links/8343c4fede0f1f09]: B/B.php#L20-L22 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::method()" +[code-links/8343c4fede0f1f09]: B/B.php#L20-L22 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\B\B::method()" -[code-links/83a40c392c8376aa]: C/C.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C" +[code-links/83a40c392c8376aa]: C/C.php + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C" -[code-links/8881166beee50a03]: C/C.php#L13 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::$property" +[code-links/8881166beee50a03]: C/C.php#L13 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::$property" -[code-links/3422d2a08c15d182]: C/C.php#L10 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::C" +[code-links/3422d2a08c15d182]: C/C.php#L10 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::C" -[code-links/6369c3badb265e68]: C/C.php#L18-L20 "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::method()" +[code-links/6369c3badb265e68]: C/C.php#L18-L20 + "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\CodeLinks\TaskTest\Invoke\C\C::method()" [//]: # (end: code-links)