From b51b62df2d382b2ca327db976a1473779ce9bc07 Mon Sep 17 00:00:00 2001
From: Jennifer Hodgdon <yahgrp@poplarware.com>
Date: Fri, 28 Mar 2014 13:19:05 -0700
Subject: [PATCH] Issue #2225265 by eojthebrave: Add Utility group/topic for
 api.drupal.org

---
 core/lib/Drupal/Component/Utility/Crypt.php   |  2 ++
 .../Drupal/Component/Utility/DiffArray.php    |  2 ++
 core/lib/Drupal/Component/Utility/Html.php    |  2 ++
 core/lib/Drupal/Component/Utility/Image.php   |  2 ++
 core/lib/Drupal/Component/Utility/Json.php    |  2 ++
 .../Drupal/Component/Utility/NestedArray.php  |  2 ++
 core/lib/Drupal/Component/Utility/Number.php  |  2 ++
 core/lib/Drupal/Component/Utility/Random.php  |  2 ++
 .../lib/Drupal/Component/Utility/Settings.php |  2 ++
 .../Drupal/Component/Utility/SortArray.php    |  2 ++
 core/lib/Drupal/Component/Utility/String.php  |  2 ++
 core/lib/Drupal/Component/Utility/Tags.php    |  2 ++
 core/lib/Drupal/Component/Utility/Timer.php   |  2 ++
 core/lib/Drupal/Component/Utility/Unicode.php |  2 ++
 .../Drupal/Component/Utility/UrlHelper.php    |  2 ++
 .../Drupal/Component/Utility/UserAgent.php    |  2 ++
 .../lib/Drupal/Component/Utility/Variable.php |  2 ++
 core/lib/Drupal/Component/Utility/Xss.php     |  2 ++
 core/modules/system/core.api.php              | 25 ++++++++++++++++++-
 19 files changed, 60 insertions(+), 1 deletion(-)

diff --git a/core/lib/Drupal/Component/Utility/Crypt.php b/core/lib/Drupal/Component/Utility/Crypt.php
index 7121f7658b51..535297db33f4 100644
--- a/core/lib/Drupal/Component/Utility/Crypt.php
+++ b/core/lib/Drupal/Component/Utility/Crypt.php
@@ -9,6 +9,8 @@
 
 /**
  * Utility class for cryptographically-secure string handling routines.
+ *
+ * @ingroup utility
  */
 class Crypt {
 
diff --git a/core/lib/Drupal/Component/Utility/DiffArray.php b/core/lib/Drupal/Component/Utility/DiffArray.php
index e496723d6b33..bd1ef5214c7a 100644
--- a/core/lib/Drupal/Component/Utility/DiffArray.php
+++ b/core/lib/Drupal/Component/Utility/DiffArray.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides helpers to perform diffs on multi dimensional arrays.
+ *
+ * @ingroup utility
  */
 class DiffArray {
 
diff --git a/core/lib/Drupal/Component/Utility/Html.php b/core/lib/Drupal/Component/Utility/Html.php
index bc0a91621433..2b5455fde849 100644
--- a/core/lib/Drupal/Component/Utility/Html.php
+++ b/core/lib/Drupal/Component/Utility/Html.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides DOMDocument helpers for parsing and serializing HTML strings.
+ *
+ * @ingroup utility
  */
 class Html {
 
diff --git a/core/lib/Drupal/Component/Utility/Image.php b/core/lib/Drupal/Component/Utility/Image.php
index dd06806b5f1f..b12a86133229 100644
--- a/core/lib/Drupal/Component/Utility/Image.php
+++ b/core/lib/Drupal/Component/Utility/Image.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides helpers to operate on images.
+ *
+ * @ingroup utility
  */
 class Image {
 
diff --git a/core/lib/Drupal/Component/Utility/Json.php b/core/lib/Drupal/Component/Utility/Json.php
index 88e55aed192d..8602d9bff7af 100644
--- a/core/lib/Drupal/Component/Utility/Json.php
+++ b/core/lib/Drupal/Component/Utility/Json.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides helpers for dealing with json.
+ *
+ * @ingroup utility
  */
 class Json {
 
diff --git a/core/lib/Drupal/Component/Utility/NestedArray.php b/core/lib/Drupal/Component/Utility/NestedArray.php
index acfdc2f9e945..8e00e068a4a4 100644
--- a/core/lib/Drupal/Component/Utility/NestedArray.php
+++ b/core/lib/Drupal/Component/Utility/NestedArray.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides helpers to perform operations on nested arrays and array keys of variable depth.
+ *
+ * @ingroup utility
  */
 class NestedArray {
 
diff --git a/core/lib/Drupal/Component/Utility/Number.php b/core/lib/Drupal/Component/Utility/Number.php
index 38a524b5aa36..453ed4aba205 100644
--- a/core/lib/Drupal/Component/Utility/Number.php
+++ b/core/lib/Drupal/Component/Utility/Number.php
@@ -8,6 +8,8 @@
 
 /**
  * Provides helper methods for manipulating numbers.
+ *
+ * @ingroup utility
  */
 class Number {
 
diff --git a/core/lib/Drupal/Component/Utility/Random.php b/core/lib/Drupal/Component/Utility/Random.php
index 2712fba4d200..f3bc4ae61e3a 100644
--- a/core/lib/Drupal/Component/Utility/Random.php
+++ b/core/lib/Drupal/Component/Utility/Random.php
@@ -9,6 +9,8 @@
 
 /**
  * Defines a utility class for creating random data.
+ *
+ * @ingroup utility
  */
 class Random {
 
diff --git a/core/lib/Drupal/Component/Utility/Settings.php b/core/lib/Drupal/Component/Utility/Settings.php
index f6f5e9157482..2b34090c7284 100644
--- a/core/lib/Drupal/Component/Utility/Settings.php
+++ b/core/lib/Drupal/Component/Utility/Settings.php
@@ -9,6 +9,8 @@
 
 /**
  * Read only settings that are initialized with the class.
+ *
+ * @ingroup utility
  */
 final class Settings {
 
diff --git a/core/lib/Drupal/Component/Utility/SortArray.php b/core/lib/Drupal/Component/Utility/SortArray.php
index 64ceb89862eb..4774f88e8e24 100644
--- a/core/lib/Drupal/Component/Utility/SortArray.php
+++ b/core/lib/Drupal/Component/Utility/SortArray.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides generic array sorting helper methods.
+ *
+ * @ingroup utility
  */
 class SortArray {
 
diff --git a/core/lib/Drupal/Component/Utility/String.php b/core/lib/Drupal/Component/Utility/String.php
index affd4df05a13..cd546ce0a1a4 100644
--- a/core/lib/Drupal/Component/Utility/String.php
+++ b/core/lib/Drupal/Component/Utility/String.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides helpers to operate on strings.
+ *
+ * @ingroup utility
  */
 class String {
 
diff --git a/core/lib/Drupal/Component/Utility/Tags.php b/core/lib/Drupal/Component/Utility/Tags.php
index db9fca05a5e5..628ce70e9b23 100644
--- a/core/lib/Drupal/Component/Utility/Tags.php
+++ b/core/lib/Drupal/Component/Utility/Tags.php
@@ -9,6 +9,8 @@
 
 /**
  * Defines a class that can explode and implode tags.
+ *
+ * @ingroup utility
  */
 class Tags {
 
diff --git a/core/lib/Drupal/Component/Utility/Timer.php b/core/lib/Drupal/Component/Utility/Timer.php
index 294632c4fbc8..714ca03bee96 100644
--- a/core/lib/Drupal/Component/Utility/Timer.php
+++ b/core/lib/Drupal/Component/Utility/Timer.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides helpers to use timers throughout a request.
+ *
+ * @ingroup utility
  */
 class Timer {
 
diff --git a/core/lib/Drupal/Component/Utility/Unicode.php b/core/lib/Drupal/Component/Utility/Unicode.php
index c5e0d82e9ac0..01e6a1f83c14 100644
--- a/core/lib/Drupal/Component/Utility/Unicode.php
+++ b/core/lib/Drupal/Component/Utility/Unicode.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides Unicode-related conversions and operations.
+ *
+ * @ingroup utility
  */
 class Unicode {
 
diff --git a/core/lib/Drupal/Component/Utility/UrlHelper.php b/core/lib/Drupal/Component/Utility/UrlHelper.php
index bf956c9940f1..a216f2140f9b 100644
--- a/core/lib/Drupal/Component/Utility/UrlHelper.php
+++ b/core/lib/Drupal/Component/Utility/UrlHelper.php
@@ -9,6 +9,8 @@
 
 /**
  * Helper class URL based methods.
+ *
+ * @ingroup utility
  */
 class UrlHelper {
 
diff --git a/core/lib/Drupal/Component/Utility/UserAgent.php b/core/lib/Drupal/Component/Utility/UserAgent.php
index 361b057ce9f1..d91074b18bed 100644
--- a/core/lib/Drupal/Component/Utility/UserAgent.php
+++ b/core/lib/Drupal/Component/Utility/UserAgent.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides user agent related utility functions.
+ *
+ * @ingroup utility
  */
 class UserAgent {
 
diff --git a/core/lib/Drupal/Component/Utility/Variable.php b/core/lib/Drupal/Component/Utility/Variable.php
index 81378960e61b..2da908b3f2fa 100644
--- a/core/lib/Drupal/Component/Utility/Variable.php
+++ b/core/lib/Drupal/Component/Utility/Variable.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides helpers for dealing with variables.
+ *
+ * @ingroup utility
  */
 class Variable {
 
diff --git a/core/lib/Drupal/Component/Utility/Xss.php b/core/lib/Drupal/Component/Utility/Xss.php
index df96015010b0..dc499136abb9 100644
--- a/core/lib/Drupal/Component/Utility/Xss.php
+++ b/core/lib/Drupal/Component/Utility/Xss.php
@@ -9,6 +9,8 @@
 
 /**
  * Provides helper to filter for cross-site scripting.
+ *
+ * @ingroup utility
  */
 class Xss {
 
diff --git a/core/modules/system/core.api.php b/core/modules/system/core.api.php
index 379954955539..04289c47da71 100644
--- a/core/modules/system/core.api.php
+++ b/core/modules/system/core.api.php
@@ -38,10 +38,11 @@
  * - @link views_overview Views @endlink
  * - @link database Database abstraction layer @endlink
  *
- * @section utility Other essential APIs
+ * @section other_essentials Other essential APIs
  *
  * - @link i18n Internationalization @endlink
  * - @link cache Caching @endlink
+ * - @link utility Utility classes and functions @endlink
  * - @link user_api User accounts, permissions, and roles @endlink
  * - @link theme_render Theme system and render API @endlink
  * - @link migration Migration @endlink
@@ -476,3 +477,25 @@
  * - Automated testing: @link testing Automated tests topic @endlink
  * @}
  */
+
+/**
+ * @defgroup utility Utility classes and functions
+ * @{
+ * Overview of utility classes and functions for developers.
+ *
+ * Drupal provides developers with a variety of utility functions that make it
+ * easier and more efficient to perform tasks that are either really common,
+ * tedious, or difficult. Utility functions help to reduce code duplication and
+ * should be used in place of one-off code whenever possible.
+ *
+ * @see common.inc
+ * @see file
+ * @see format
+ * @see mail.inc
+ * @see php_wrappers
+ * @see sanitization
+ * @see session.inc
+ * @see transliteration
+ * @see validation
+ * @}
+ */
-- 
GitLab