* compact all phpdoc block comments with only one annotation into one…

…-linear by regex replacing `\/\*\*\n\s+\* (@.+)\n\s+\*/` to `/** $1 */` @ be
n0099 · Oct 11, 2024 · 7425b88 · 7425b88
1 parent bf05a24
commit 7425b88
Show file tree

Hide file tree

Showing 14 changed files with 16 additions and 48 deletions.
diff --git a/be/src/Entity/BlobResourceGetter.php b/be/src/Entity/BlobResourceGetter.php
@@ -33,9 +33,7 @@ public static function protoBuf($value, string $protoBufClass): ?array
         return \Safe\json_decode($protoBuf->serializeToJsonString(), assoc: true);
     }
 
-    /**
-     * @param ?resource $value
-     */
+    /** @param ?resource $value */
     public static function resource($value): ?string
     {
         if ($value === null) {

diff --git a/be/src/Entity/LatestReplier.php b/be/src/Entity/LatestReplier.php
@@ -50,9 +50,7 @@ public function getDisplayName(): ?string
         return BlobResourceGetter::resource($this->displayName);
     }
 
-    /**
-     * @param resource|null $displayName
-     */
+    /** @param resource|null $displayName */
     public function setDisplayName(null $displayName): void
     {
         $this->displayName = $displayName;

diff --git a/be/src/Entity/Post/Content/PostContent.php b/be/src/Entity/Post/Content/PostContent.php
@@ -17,9 +17,7 @@ public function getContent(): ?array
         return BlobResourceGetter::protoBufWrapper($this->protoBufBytes, PostContentWrapper::class);
     }
 
-    /**
-     * @param resource|null $protoBufBytes
-     */
+    /** @param resource|null $protoBufBytes */
     public function setProtoBufBytes(null $protoBufBytes): void
     {
         $this->protoBufBytes = $protoBufBytes;

diff --git a/be/src/Entity/Post/Reply.php b/be/src/Entity/Post/Reply.php
@@ -74,9 +74,7 @@ public function getGeolocation(): ?array
         return BlobResourceGetter::protoBuf($this->geolocation, Lbs::class);
     }
 
-    /**
-     * @param resource|null $geolocation
-     */
+    /** @param resource|null $geolocation */
     public function setGeolocation(null $geolocation): void
     {
         $this->geolocation = $geolocation;

diff --git a/be/src/Entity/Post/Thread.php b/be/src/Entity/Post/Thread.php
@@ -143,9 +143,7 @@ public function getZan(): ?array
         return BlobResourceGetter::protoBuf($this->zan, Zan::class);
     }
 
-    /**
-     * @param resource|null $zan
-     */
+    /** @param resource|null $zan */
     public function setZan(null $zan): void
     {
         $this->zan = $zan;
@@ -156,9 +154,7 @@ public function getGeolocation(): ?array
         return BlobResourceGetter::protoBuf($this->geolocation, Lbs::class);
     }
 
-    /**
-     * @param resource|null $geolocation
-     */
+    /** @param resource|null $geolocation */
     public function setGeolocation(null $geolocation): void
     {
         $this->geolocation = $geolocation;

diff --git a/be/src/Entity/User.php b/be/src/Entity/User.php
@@ -51,9 +51,7 @@ public function getDisplayName(): ?string
         return BlobResourceGetter::resource($this->displayName);
     }
 
-    /**
-     * @param resource|null $displayName
-     */
+    /** @param resource|null $displayName */
     public function setDisplayName(null $displayName): void
     {
         $this->displayName = $displayName;
@@ -104,9 +102,7 @@ public function getIcon(): ?array
         return BlobResourceGetter::protoBufWrapper($this->icon, UserIconWrapper::class);
     }
 
-    /**
-     * @param resource|null $icon
-     */
+    /** @param resource|null $icon */
     public function setIcon(null $icon): void
     {
         $this->icon = $icon;

diff --git a/be/src/PostsQuery/BaseQuery.php b/be/src/PostsQuery/BaseQuery.php
@@ -126,9 +126,7 @@ protected function setResult(
         $this->stopwatch->stop('setResult');
     }
 
-    /**
-     * @return array{result: Collection, hasMorePages: bool}
-     */
+    /** @return array{result: Collection, hasMorePages: bool} */
     public static function hasQueryResultMorePages(QueryBuilder $query, int $limit): array
     {
         $results = collect($query->setMaxResults($limit + 1)->getQuery()->getResult());

diff --git a/be/src/Repository/Post/Content/ReplyContentRepository.php b/be/src/Repository/Post/Content/ReplyContentRepository.php
@@ -7,9 +7,7 @@
 use Doctrine\Persistence\ManagerRegistry;
 use Symfony\Component\DependencyInjection\Attribute\Exclude;
 
-/**
- * @extends PostContentRepository<ReplyContent>
- */
+/** @extends PostContentRepository<ReplyContent> */
 #[Exclude]
 class ReplyContentRepository extends PostContentRepository
 {

diff --git a/be/src/Repository/Post/Content/SubReplyContentRepository.php b/be/src/Repository/Post/Content/SubReplyContentRepository.php
@@ -8,9 +8,7 @@
 use Doctrine\Persistence\ManagerRegistry;
 use Symfony\Component\DependencyInjection\Attribute\Exclude;
 
-/**
- * @extends PostRepository<SubReplyContent>
- */
+/** @extends PostRepository<SubReplyContent> */
 #[Exclude]
 class SubReplyContentRepository extends PostContentRepository
 {

diff --git a/be/src/Repository/Post/PostRepositoryFactory.php b/be/src/Repository/Post/PostRepositoryFactory.php
@@ -40,9 +40,7 @@ public function newSubReplyContent(int $fid): SubReplyContentRepository
         return new SubReplyContentRepository($this->registry, $this->entityManager, $fid);
     }
 
-    /**
-     * @return array{thread: ThreadRepository, reply: ReplyRepository, subReply: SubReplyRepository}
-     */
+    /** @return array{thread: ThreadRepository, reply: ReplyRepository, subReply: SubReplyRepository} */
     public function newForumPosts(int $fid): array
     {
         return array_combine(

diff --git a/be/src/Repository/Post/ReplyRepository.php b/be/src/Repository/Post/ReplyRepository.php
@@ -7,9 +7,7 @@
 use Doctrine\Persistence\ManagerRegistry;
 use Symfony\Component\DependencyInjection\Attribute\Exclude;
 
-/**
- * @extends PostRepository<Reply>
- */
+/** @extends PostRepository<Reply> */
 #[Exclude]
 class ReplyRepository extends PostRepository
 {

diff --git a/be/src/Repository/Post/SubReplyRepository.php b/be/src/Repository/Post/SubReplyRepository.php
@@ -7,9 +7,7 @@
 use Doctrine\Persistence\ManagerRegistry;
 use Symfony\Component\DependencyInjection\Attribute\Exclude;
 
-/**
- * @extends PostRepository<SubReply>
- */
+/** @extends PostRepository<SubReply> */
 #[Exclude]
 class SubReplyRepository extends PostRepository
 {

diff --git a/be/src/Repository/Post/ThreadRepository.php b/be/src/Repository/Post/ThreadRepository.php
@@ -7,9 +7,7 @@
 use Doctrine\Persistence\ManagerRegistry;
 use Symfony\Component\DependencyInjection\Attribute\Exclude;
 
-/**
- * @extends PostRepository<Thread>
- */
+/** @extends PostRepository<Thread> */
 #[Exclude]
 class ThreadRepository extends PostRepository
 {

diff --git a/be/src/Repository/RepositoryWithSplitFid.php b/be/src/Repository/RepositoryWithSplitFid.php
@@ -13,9 +13,7 @@ abstract class RepositoryWithSplitFid extends BaseRepository
 {
     abstract protected function getTableNameSuffix(): string;
 
-    /**
-     * @param class-string<T> $postRepositoryClass
-     */
+    /** @param class-string<T> $postRepositoryClass */
     public function __construct(
         ManagerRegistry $registry,
         EntityManagerInterface $entityManager,