Merge pull request #581 from creative-commoners/pulls/2.1/docblock

MNT Update @methods on class docblocks
silverstripe · Dec 14, 2023 · 8f8df1b · 8f8df1b
2 parents c9903d2 + 54a13b8
commit 8f8df1b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 7 deletions.
diff --git a/src/File.php b/src/File.php
@@ -88,14 +88,13 @@
  * @property int $ParentID ID of parent File/Folder
  * @property int $OwnerID ID of Member who owns the file
  *
- * @method File Parent() Returns parent File
- * @method Member Owner() Returns Member object of file owner.
- * @method HasManyList|FileLink[] BackLinks() List of SiteTreeLink objects attached to this page
- *
  * @mixin Hierarchy
  * @mixin Versioned
  * @mixin RecursivePublishable
  * @mixin InheritedPermissionsExtension
+ * @method HasManyList<FileLink> BackLinks()
+ * @method Member Owner()
+ * @method File Parent()
  */
 class File extends DataObject implements AssetContainer, Thumbnail, CMSPreviewable, PermissionProvider, Resettable
 {

diff --git a/src/Shortcodes/FileLink.php b/src/Shortcodes/FileLink.php
@@ -8,8 +8,8 @@
 /**
  * Represents a link between a dataobject parent and a file shortcode in a HTML content area
  *
- * @method DataObject Parent() Parent object
- * @method File Linked() File being linked to
+ * @method File Linked()
+ * @method DataObject Parent()
  */
 class FileLink extends DataObject
 {

diff --git a/src/Shortcodes/FileLinkTracking.php b/src/Shortcodes/FileLinkTracking.php
@@ -24,7 +24,7 @@
  * only be enabled for the Stage record.
  *
  * @property DataObject|FileLinkTracking $owner
- * @method ManyManyList|File[] FileTracking() List of files linked on this dataobject
+ * @method SilverStripe\ORM\ManyManyThroughList<File> FileTracking()
  */
 class FileLinkTracking extends DataExtension
 {