From 67f2c101c1a415afdf40ab02b716e242b57fd5e1 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Mon, 28 Sep 2009 22:22:54 +0000
Subject: - Patch #584966 by mr.baileys, sun: add doxygen group for PHP
 function wrappers in Drupal.

---
 includes/unicode.inc | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

(limited to 'includes/unicode.inc')

diff --git a/includes/unicode.inc b/includes/unicode.inc
index da4a37377..4aa363c28 100644
--- a/includes/unicode.inc
+++ b/includes/unicode.inc
@@ -116,6 +116,8 @@ function unicode_requirements() {
  *   The XML data which will be parsed later.
  * @return
  *   An XML parser object or FALSE on error.
+ *
+ * @ingroup php_wrappers
  */
 function drupal_xml_parser_create(&$data) {
   // Default XML encoding is UTF-8
@@ -207,7 +209,7 @@ function drupal_truncate_bytes($string, $len) {
   if ((ord($string[$len]) < 0x80) || (ord($string[$len]) >= 0xC0)) {
     return substr($string, 0, $len);
   }
-  // Scan backwards to beginning of the byte sequence. 
+  // Scan backwards to beginning of the byte sequence.
   while (--$len >= 0 && ord($string[$len]) >= 0x80 && ord($string[$len]) < 0xC0);
 
   return substr($string, 0, $len);
@@ -393,6 +395,8 @@ function _decode_entities($prefix, $codepoint, $original, &$html_entities, &$exc
 /**
  * Count the amount of characters in a UTF-8 string. This is less than or
  * equal to the byte count.
+ *
+ * @ingroup php_wrappers
  */
 function drupal_strlen($text) {
   global $multibyte;
@@ -407,6 +411,8 @@ function drupal_strlen($text) {
 
 /**
  * Uppercase a UTF-8 string.
+ *
+ * @ingroup php_wrappers
  */
 function drupal_strtoupper($text) {
   global $multibyte;
@@ -424,6 +430,8 @@ function drupal_strtoupper($text) {
 
 /**
  * Lowercase a UTF-8 string.
+ *
+ * @ingroup php_wrappers
  */
 function drupal_strtolower($text) {
   global $multibyte;
@@ -449,6 +457,8 @@ function _unicode_caseflip($matches) {
 
 /**
  * Capitalize the first letter of a UTF-8 string.
+ *
+ * @ingroup php_wrappers
  */
 function drupal_ucfirst($text) {
   // Note: no mbstring equivalent!
@@ -462,6 +472,8 @@ function drupal_ucfirst($text) {
  * Note that for cutting off a string at a known character/substring
  * location, the usage of PHP's normal strpos/substr is safe and
  * much faster.
+ *
+ * @ingroup php_wrappers
  */
 function drupal_substr($text, $start, $length = NULL) {
   global $multibyte;
@@ -545,5 +557,3 @@ function drupal_substr($text, $start, $length = NULL) {
     return substr($text, $istart, max(0, $iend - $istart + 1));
   }
 }
-
-
-- 
cgit v1.2.3