Commit b51b62df authored by jhodgdon's avatar jhodgdon

Issue #2225265 by eojthebrave: Add Utility group/topic for api.drupal.org

parent e9cd089f
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Utility class for cryptographically-secure string handling routines. * Utility class for cryptographically-secure string handling routines.
*
* @ingroup utility
*/ */
class Crypt { class Crypt {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides helpers to perform diffs on multi dimensional arrays. * Provides helpers to perform diffs on multi dimensional arrays.
*
* @ingroup utility
*/ */
class DiffArray { class DiffArray {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides DOMDocument helpers for parsing and serializing HTML strings. * Provides DOMDocument helpers for parsing and serializing HTML strings.
*
* @ingroup utility
*/ */
class Html { class Html {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides helpers to operate on images. * Provides helpers to operate on images.
*
* @ingroup utility
*/ */
class Image { class Image {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides helpers for dealing with json. * Provides helpers for dealing with json.
*
* @ingroup utility
*/ */
class Json { class Json {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides helpers to perform operations on nested arrays and array keys of variable depth. * Provides helpers to perform operations on nested arrays and array keys of variable depth.
*
* @ingroup utility
*/ */
class NestedArray { class NestedArray {
......
...@@ -8,6 +8,8 @@ ...@@ -8,6 +8,8 @@
/** /**
* Provides helper methods for manipulating numbers. * Provides helper methods for manipulating numbers.
*
* @ingroup utility
*/ */
class Number { class Number {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Defines a utility class for creating random data. * Defines a utility class for creating random data.
*
* @ingroup utility
*/ */
class Random { class Random {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Read only settings that are initialized with the class. * Read only settings that are initialized with the class.
*
* @ingroup utility
*/ */
final class Settings { final class Settings {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides generic array sorting helper methods. * Provides generic array sorting helper methods.
*
* @ingroup utility
*/ */
class SortArray { class SortArray {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides helpers to operate on strings. * Provides helpers to operate on strings.
*
* @ingroup utility
*/ */
class String { class String {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Defines a class that can explode and implode tags. * Defines a class that can explode and implode tags.
*
* @ingroup utility
*/ */
class Tags { class Tags {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides helpers to use timers throughout a request. * Provides helpers to use timers throughout a request.
*
* @ingroup utility
*/ */
class Timer { class Timer {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides Unicode-related conversions and operations. * Provides Unicode-related conversions and operations.
*
* @ingroup utility
*/ */
class Unicode { class Unicode {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Helper class URL based methods. * Helper class URL based methods.
*
* @ingroup utility
*/ */
class UrlHelper { class UrlHelper {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides user agent related utility functions. * Provides user agent related utility functions.
*
* @ingroup utility
*/ */
class UserAgent { class UserAgent {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides helpers for dealing with variables. * Provides helpers for dealing with variables.
*
* @ingroup utility
*/ */
class Variable { class Variable {
......
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
/** /**
* Provides helper to filter for cross-site scripting. * Provides helper to filter for cross-site scripting.
*
* @ingroup utility
*/ */
class Xss { class Xss {
......
...@@ -38,10 +38,11 @@ ...@@ -38,10 +38,11 @@
* - @link views_overview Views @endlink * - @link views_overview Views @endlink
* - @link database Database abstraction layer @endlink * - @link database Database abstraction layer @endlink
* *
* @section utility Other essential APIs * @section other_essentials Other essential APIs
* *
* - @link i18n Internationalization @endlink * - @link i18n Internationalization @endlink
* - @link cache Caching @endlink * - @link cache Caching @endlink
* - @link utility Utility classes and functions @endlink
* - @link user_api User accounts, permissions, and roles @endlink * - @link user_api User accounts, permissions, and roles @endlink
* - @link theme_render Theme system and render API @endlink * - @link theme_render Theme system and render API @endlink
* - @link migration Migration @endlink * - @link migration Migration @endlink
...@@ -476,3 +477,25 @@ ...@@ -476,3 +477,25 @@
* - Automated testing: @link testing Automated tests topic @endlink * - 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
* @}
*/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment