PHPdoc

fisharebest · Dec 23, 2024 · 26f2c62 · 26f2c62
1 parent 8359930
commit 26f2c62
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 46 deletions.
diff --git a/app/Services/LinkedRecordService.php b/app/Services/LinkedRecordService.php
@@ -43,11 +43,7 @@
 class LinkedRecordService
 {
     /**
-     * Find all records linked to a record.
-     *
-     * @param GedcomRecord $record
-     *
-     * @return Collection<int,Family>
+     * @return Collection<int,GedcomRecord>
      */
     public function allLinkedRecords(GedcomRecord $record): Collection
     {
@@ -78,11 +74,6 @@ public function allLinkedRecords(GedcomRecord $record): Collection
     }
 
     /**
-     * Find families linked to a record.
-     *
-     * @param GedcomRecord $record
-     * @param string|null  $link_type
-     *
      * @return Collection<int,Family>
      */
     public function linkedFamilies(GedcomRecord $record, string|null $link_type = null): Collection
@@ -109,11 +100,6 @@ public function linkedFamilies(GedcomRecord $record, string|null $link_type = nu
     }
 
     /**
-     * Find individuals linked to a record.
-     *
-     * @param GedcomRecord $record
-     * @param string|null  $link_type
-     *
      * @return Collection<int,Individual>
      */
     public function linkedIndividuals(GedcomRecord $record, string|null $link_type = null): Collection
@@ -140,10 +126,6 @@ public function linkedIndividuals(GedcomRecord $record, string|null $link_type =
     }
 
     /**
-     * Find locations linked to a record.
-     *
-     * @param GedcomRecord $record
-     *
      * @return Collection<int,Location>
      */
     public function linkedLocations(GedcomRecord $record): Collection
@@ -165,10 +147,6 @@ public function linkedLocations(GedcomRecord $record): Collection
     }
 
     /**
-     * Find media objects linked to a record.
-     *
-     * @param GedcomRecord $record
-     *
      * @return Collection<int,Media>
      */
     public function linkedMedia(GedcomRecord $record): Collection
@@ -189,10 +167,6 @@ public function linkedMedia(GedcomRecord $record): Collection
     }
 
     /**
-     * Find notes linked to a record.
-     *
-     * @param GedcomRecord $record
-     *
      * @return Collection<int,Note>
      */
     public function linkedNotes(GedcomRecord $record): Collection
@@ -214,10 +188,6 @@ public function linkedNotes(GedcomRecord $record): Collection
     }
 
     /**
-     * Find repositories linked to a record.
-     *
-     * @param GedcomRecord $record
-     *
      * @return Collection<int,Repository>
      */
     public function linkedRepositories(GedcomRecord $record): Collection
@@ -239,10 +209,6 @@ public function linkedRepositories(GedcomRecord $record): Collection
     }
 
     /**
-     * Find sources linked to a record.
-     *
-     * @param GedcomRecord $record
-     *
      * @return Collection<int,Source>
      */
     public function linkedSources(GedcomRecord $record): Collection
@@ -263,10 +229,6 @@ public function linkedSources(GedcomRecord $record): Collection
     }
 
     /**
-     * Find submitters linked to a record.
-     *
-     * @param GedcomRecord $record
-     *
      * @return Collection<int,Repository>
      */
     public function linkedSubmitters(GedcomRecord $record): Collection

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1620,12 +1620,6 @@ parameters:
 			count: 1
 			path: app/Http/RequestHandlers/DataFixUpdateAll.php
 
-		-
-			message: '#^Instanceof between Fisharebest\\Webtrees\\Family and Fisharebest\\Webtrees\\Family will always evaluate to true\.$#'
-			identifier: instanceof.alwaysTrue
-			count: 1
-			path: app/Http/RequestHandlers/DeleteRecord.php
-
 		-
 			message: '#^Method Fisharebest\\Webtrees\\Http\\RequestHandlers\\DeleteRecord\:\:removeLinks\(\) should return string but returns string\|null\.$#'
 			identifier: return.type
@@ -7135,7 +7129,7 @@ parameters:
 			path: app/Services/IndividualFactsService.php
 
 		-
-			message: '#^Method Fisharebest\\Webtrees\\Services\\LinkedRecordService\:\:allLinkedRecords\(\) should return Illuminate\\Support\\Collection\<int, Fisharebest\\Webtrees\\Family\> but returns Illuminate\\Support\\Collection\<\(int\|string\), Fisharebest\\Webtrees\\GedcomRecord\|null\>\.$#'
+			message: '#^Method Fisharebest\\Webtrees\\Services\\LinkedRecordService\:\:allLinkedRecords\(\) should return Illuminate\\Support\\Collection\<int, Fisharebest\\Webtrees\\GedcomRecord\> but returns Illuminate\\Support\\Collection\<\(int\|string\), Fisharebest\\Webtrees\\GedcomRecord\|null\>\.$#'
 			identifier: return.type
 			count: 1
 			path: app/Services/LinkedRecordService.php