src/hbcore/i18n/hbstringutil.cpp
changeset 3 11d3954df52a
parent 1 f7ac710697a9
child 6 c3690ec91ef8
--- a/src/hbcore/i18n/hbstringutil.cpp	Fri May 14 16:09:54 2010 +0300
+++ b/src/hbcore/i18n/hbstringutil.cpp	Thu May 27 13:10:59 2010 +0300
@@ -42,17 +42,12 @@
 #endif
 
 /*!
-    @beta
+    @stable
     @hbcore
     \class HbStringUtil
     \brief The HbStringUtil class can be used to execute operations on strings,
     such as comparisons and finding data sequences.
 
-    \ingroup i18n
-
-    \warning This class is only useful in Symbian platforms since it uses Symbian
-    methods in order to implement different functionalities.
-
     \sa HbStringUtil
 */
 
@@ -85,6 +80,8 @@
 /*!
     Searches source string's collated data for a
     match with collated data supplied in pattern string
+      
+    \attention Cross-Platform API
     
     \param strFrom Source string.
     \param strToMatch Pattern string.
@@ -97,6 +94,7 @@
     \param wildChar Wild card character.
     \param wildSequenceChar Wild card sequence character.
     \param escapeChar The escape character, for example,  '?', '*'.
+    
     \return If a match is found the offset within source string's
     data where the match first occurs. -1 if match is not found.
     
@@ -144,6 +142,8 @@
     Compares source string's data with the other string's
     data using the specified collation method.
     
+    \attention Cross-Platform API
+    
     \param string1 Source string.
     \param string2 String whose data is to be compared with the source string.
     \param maxLevel Maximum level to use for comparing.
@@ -152,6 +152,7 @@
     Level 2 - Character identity, accents and case; 
     Level 3 - Character identity, accents, case and Unicode value; 
     \param flags The flags that will be used. Default value is Default.
+    
     \return Positive if source string is greater, negative if it is less and 
     zero	if the content of both strings match.
     
@@ -188,6 +189,8 @@
     data sequence in the aStrFrom to the specified maximum
     collation level.
     
+    \attention Cross-Platform API
+    
     \param strFrom Source string.
     \param strToFind String whose data is to be compared with the source string.
     \param maxLevel The maximum collation level.
@@ -195,6 +198,7 @@
     Level 1 - Character identity and accents; 
     Level 2 - Character identity, accents and case; 
     Level 3 - Character identity, accents, case and Unicode value; 
+    
     \return Offset of the data sequence from the beginning of the
     aStrFrom. -1 if the data sequence cannot be found.
     
@@ -225,8 +229,11 @@
     Searches source string's folded data for a
     match with folded data supplied in pattern string
     
+    \attention Cross-Platform API
+    
     \param strFrom Source string.
     \param strToMatch Pattern string.
+    
     \return If a match is found the offset within source string's
     data where the match first occurs. -1 if match is not found.
     
@@ -257,8 +264,11 @@
     Searches for the first occurence of the specified folded 
     data sequence in the strFrom.
     
+    \attention Cross-Platform API
+    
     \param strFrom Source string.
     \param strToFind String whose data is to be compared with the source string.
+    
     \return Offset of the data sequence from the beginning of the
     strFrom. -1 if the data sequence cannot be found. Zero,
     if the length of search data sequence is zero.
@@ -283,8 +293,11 @@
     Compares source string's folded data with the other string's
     folded data.
     
+    \attention Cross-Platform API
+    
     \param string1 Source string.
     \param string2 String whose data is to be compared with the source string.
+    
     \return Positive if source string is greater, negative if it is less and 
     zero if the content of both strings match.
     
@@ -323,6 +336,9 @@
 
 /*!
     Converts digits to native digits based on current UI language.
+    
+    \attention Cross-Platform API
+    
     \param str digits to be converted.
  */
 QString HbStringUtil::convertDigits( const QString str ) 
@@ -344,6 +360,9 @@
 
 /*!
     Converts the digit from Latin to native or native to latin or native to native
+    
+    \attention Cross-Platform API
+    
     \param str digits to be converted.
     \param digitType type of the digit to be converted to
  */
@@ -377,6 +396,8 @@
 /*!
     Sorts QStrings into alphabetically order (overwrites the strList's original content)
     
+    \attention Cross-Platform API
+    
     \param strList List of QStrings which need to be sorted.
     
     Example