From fa97dcd360890f01708af65ce7e7aceed642ae53 Mon Sep 17 00:00:00 2001 From: colemanw Date: Thu, 12 Oct 2023 22:24:11 -0400 Subject: [PATCH] Docblocks - Remove 'experimental' comments and other copy-edits --- CRM/Utils/Hook.php | 11 +++++------ .../core/Civi/Afform/AngularDependencyMapper.php | 2 +- .../core/Civi/Api4/Utils/AfformFormatTrait.php | 12 ++++++------ 3 files changed, 12 insertions(+), 13 deletions(-) diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php index a4599f2ad468..2477cb6325cb 100644 --- a/CRM/Utils/Hook.php +++ b/CRM/Utils/Hook.php @@ -677,7 +677,7 @@ public static function xmlMenu(&$files) { } /** - * (Experimental) This hook is called when build the menu table. + * This hook is called when building the menu table. * * @param array $items * List of records to include in menu table. @@ -1176,7 +1176,7 @@ public static function mailingGroups(&$form, &$groups, &$mailings) { } /** - * (Experimental) Modify the list of template-types used for CiviMail composition. + * Modify the list of template-types used for CiviMail composition. * * @param array $types * Sequentially indexed list of template types. Each type specifies: @@ -1864,10 +1864,9 @@ public static function buildGroupContactCache(array $savedSearch, int $groupID, } /** - * (EXPERIMENTAL) Scan extensions for a list of auto-registered interfaces. + * Scan extensions for a list of auto-registered interfaces. * - * This hook is currently experimental. It is a means to implementing `mixin/scan-classes@1`. - * If there are no major difficulties circa 5.55, then it can be marked stable. + * @see mixin/scan-classes@1 * * @param string[] $classes * List of classes which may be of interest to the class-scanner. @@ -2670,7 +2669,7 @@ public static function alterResourceSettings(&$data) { } /** - * EXPERIMENTAL: This hook allows one to register additional Angular modules + * Register Angular modules * * @param array $angularModules * List of modules. Each module defines: diff --git a/ext/afform/core/Civi/Afform/AngularDependencyMapper.php b/ext/afform/core/Civi/Afform/AngularDependencyMapper.php index 67ac20c999be..692ad8aebf89 100644 --- a/ext/afform/core/Civi/Afform/AngularDependencyMapper.php +++ b/ext/afform/core/Civi/Afform/AngularDependencyMapper.php @@ -12,7 +12,7 @@ namespace Civi\Afform; /** - * Class AngularDependencyMapper + * Class used to calculate Afform Angular dependencies. * @package Civi\Afform */ class AngularDependencyMapper { diff --git a/ext/afform/core/Civi/Api4/Utils/AfformFormatTrait.php b/ext/afform/core/Civi/Api4/Utils/AfformFormatTrait.php index 143c7edc0f16..4f20d569d3bd 100644 --- a/ext/afform/core/Civi/Api4/Utils/AfformFormatTrait.php +++ b/ext/afform/core/Civi/Api4/Utils/AfformFormatTrait.php @@ -14,9 +14,9 @@ trait AfformFormatTrait { /** * Controls the return format of the "layout" property - * - html will return layout html as-is. - * - shallow will convert most html to an array, but leave tag attributes and af-markup containers alone. - * - deep will attempt to convert all html to an array, including tag attributes. + * - "html" will return layout html as-is. + * - "shallow" will convert most html to an array, but leave tag attributes and af-markup containers alone. + * - "deep" will attempt to convert all html to an array, including tag attributes. * * @var string * @options html,shallow,deep @@ -26,10 +26,10 @@ trait AfformFormatTrait { /** * Optionally manage whitespace for the "layout" property * - * This option will strip whitepace from the returned layout array for "get" actions, - * and will auto-indent the aff.html for "save" actions. + * This option will strip whitepace from the returned layout array for `get` actions, + * and will auto-indent the aff.html for `save` actions. * - * Note: currently this has no affect on "get" with "html" return format, which returns html as-is. + * Note: Has no effect on `get` with "html" return format, which returns html as-is. * * @var bool */