From: Tim Otten <totten@civicrm.org>
Date: Tue, 25 Aug 2020 22:35:30 +0000 (-0700)
Subject: (NFC) Docblock tweaks
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=950538ac8a0dd528896a921685e0d83c38be0a34;p=civicrm-core.git

(NFC) Docblock tweaks
---

diff --git a/CRM/Core/Resources/CollectionAdderInterface.php b/CRM/Core/Resources/CollectionAdderInterface.php
index 42d636d23d..5f7e6b0ead 100644
--- a/CRM/Core/Resources/CollectionAdderInterface.php
+++ b/CRM/Core/Resources/CollectionAdderInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * The collection-adder interface provides write-only support for a collection.
+ *
+ * @see CRM_Core_Resources_CollectionAdderTrait
  */
 interface CRM_Core_Resources_CollectionAdderInterface {
 
diff --git a/CRM/Core/Resources/CollectionAdderTrait.php b/CRM/Core/Resources/CollectionAdderTrait.php
index 03fcd65ae3..da3ecb2904 100644
--- a/CRM/Core/Resources/CollectionAdderTrait.php
+++ b/CRM/Core/Resources/CollectionAdderTrait.php
@@ -14,7 +14,9 @@
  *
  * This trait is a building-block for creating classes which maintain a list of
  * resources. It defines a set of helper functions which provide syntactic sugar
- * for calling the add() method.
+ * for calling the add() method. It implements most of the `CollectionAdderInterface`.
+ *
+ * @see CRM_Core_Resources_CollectionAdderInterface
  */
 trait CRM_Core_Resources_CollectionAdderTrait {
 
diff --git a/CRM/Core/Resources/CollectionInterface.php b/CRM/Core/Resources/CollectionInterface.php
index 5e278131de..e3d1433b71 100644
--- a/CRM/Core/Resources/CollectionInterface.php
+++ b/CRM/Core/Resources/CollectionInterface.php
@@ -74,6 +74,8 @@
  * Passing options in array (key-value) notation is clearest. For backward
  * compatibility, some methods (eg `addScript()`) accept options in positional form.
  * Where applicable, the docblock of each `addFoo()` will include a comment about positional form.
+ *
+ * @see CRM_Core_Resources_CollectionTrait
  */
 interface CRM_Core_Resources_CollectionInterface {
 
diff --git a/CRM/Core/Resources/CollectionTrait.php b/CRM/Core/Resources/CollectionTrait.php
index d920705871..b7616edafc 100644
--- a/CRM/Core/Resources/CollectionTrait.php
+++ b/CRM/Core/Resources/CollectionTrait.php
@@ -13,10 +13,9 @@
  * Class CRM_Core_Resources_CollectionTrait
  *
  * This is a building-block for creating classes which maintain a list of resources.
+ * It implements of the `CollectionInterface`.
  *
- * The class is generally organized in two sections: First, we have core
- * bit that manages a list of '$snippets'. Second, we have a set of helper
- * functions which add some syntactic sugar for the snippets.
+ * @see CRM_Core_Resources_CollectionInterface
  */
 trait CRM_Core_Resources_CollectionTrait {
 
diff --git a/CRM/Core/Resources/Common.php b/CRM/Core/Resources/Common.php
index 3dc2dd7c52..e5f34cc1d9 100644
--- a/CRM/Core/Resources/Common.php
+++ b/CRM/Core/Resources/Common.php
@@ -23,6 +23,7 @@ class CRM_Core_Resources_Common {
    * @param string $name
    *   i.e. 'coreStyles'
    * @return \CRM_Core_Resources_Bundle
+   * @see \Civi\Core\Container::createContainer()
    */
   public static function createStyleBundle($name) {
     $bundle = new CRM_Core_Resources_Bundle($name);
@@ -51,6 +52,7 @@ class CRM_Core_Resources_Common {
    * @param string $name
    *   i.e. 'coreResources'
    * @return \CRM_Core_Resources_Bundle
+   * @see \Civi\Core\Container::createContainer()
    */
   public static function createFullBundle($name) {
     $bundle = new CRM_Core_Resources_Bundle($name);