DOC Update PHPDocs

src/Form/AbstractLinkField.php

@@ -40,8 +40,11 @@ public function getExcludeLinkTextField(): bool
     }
 
     /**
-     * Set allowed types for LinkField
+     * Set which types of link are allowed for this field.
+     * Types must be FQCN of Link subclasses.
+     *
      * @param string[] $types
+     * @throws InvalidArgumentException if $types is empty or any type in the array is invalid
      */
     public function setAllowedTypes(array $types): static
     {
@@ -51,17 +54,17 @@ public function setAllowedTypes(array $types): static
     }
 
     /**
-     * Get allowed types for LinkField
+     * Get the types of link which are allowed for this field.
      */
     public function getAllowedTypes(): array
     {
         return $this->allowedTypes;
     }
 
     /**
-     * The method returns an associational array converted to a JSON string,
+     * The method returns a stringified JSON object
      * of available link types with additional parameters necessary
-     * for full-fledged work on the client side.
+     * for work on the client side.
      * @throws InvalidArgumentException
      */
     public function getTypesProp(): string

src/Models/EmailLink.php

@@ -20,9 +20,6 @@ class EmailLink extends Link
         'Email' => 'Varchar(255)',
     ];
 
-    /**
-     * Set the priority of this link type in the CMS menu
-     */
     private static int $menu_priority = 30;
 
     private static $icon = 'font-icon-p-mail';

src/Models/ExternalLink.php

@@ -20,9 +20,6 @@ class ExternalLink extends Link
         'ExternalUrl' => 'Varchar',
     ];
 
-    /**
-     * Set the priority of this link type in the CMS menu
-     */
     private static int $menu_priority = 20;
 
     private static $icon = 'font-icon-external-link';

src/Models/FileLink.php

@@ -21,9 +21,6 @@ class FileLink extends Link
         'File' => File::class,
     ];
 
-    /**
-     * Set the priority of this link type in the CMS menu
-     */
     private static int $menu_priority = 10;
 
     private static $icon = 'font-icon-image';

src/Models/Link.php

@@ -18,7 +18,7 @@
 use SilverStripe\Forms\Tip;
 
 /**
- * A Link Data Object. This class should be treated as abstract. You should never directly interact with a plain Link
+ * A Link DataObject. This class should be treated as abstract. You should never directly interact with a plain Link
  * instance
  *
  * Note that links should be added via a has_one or has_many relation, NEVER a many_many relation. This is because
@@ -62,7 +62,8 @@ class Link extends DataObject
     private ?string $linkType = null;
 
     /**
-     * Set the priority of this link type in the CMS menu
+     * Set the priority of this link type in the link picker.
+     * A link with a higher priority value will be displayed lower in the list.
      */
     private static int $menu_priority = 100;
 

src/Models/PhoneLink.php

@@ -17,11 +17,8 @@ class PhoneLink extends Link
         'Phone' => 'Varchar(255)',
     ];
 
-    /**
-     * Set the priority of this link type in the CMS menu
-     */
     private static int $menu_priority = 40;
-    
+
     private static $icon = 'font-icon-mobile';
 
     public function getCMSFields(): FieldList

src/Models/SiteTreeLink.php

@@ -33,9 +33,6 @@ class SiteTreeLink extends Link
         'Page' => SiteTree::class,
     ];
 
-    /**
-     * Set the priority of this link type in the CMS menu
-     */
     private static int $menu_priority = 0;
 
     private static $icon = 'font-icon-page';