summaryrefslogtreecommitdiff
path: root/src/fbasicstring.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/fbasicstring.h')
-rw-r--r--src/fbasicstring.h35
1 files changed, 26 insertions, 9 deletions
diff --git a/src/fbasicstring.h b/src/fbasicstring.h
index b9e4871..fbfc5ef 100644
--- a/src/fbasicstring.h
+++ b/src/fbasicstring.h
@@ -706,6 +706,7 @@ namespace Bu
706 /** 706 /**
707 * Append another FString to this one. 707 * Append another FString to this one.
708 *@param sData (MyType &) The FString to append. 708 *@param sData (MyType &) The FString to append.
709 *@param nStart Start position in sData to start copying from.
709 *@param nLen How much data to append. 710 *@param nLen How much data to append.
710 */ 711 */
711 void append( const MyType & sData, long nStart, long nLen ) 712 void append( const MyType & sData, long nStart, long nLen )
@@ -715,6 +716,11 @@ namespace Bu
715 append( sData.getStr(), nStart, nLen ); 716 append( sData.getStr(), nStart, nLen );
716 } 717 }
717 718
719 /**
720 * Append data to this FString using the passed in iterator as a base.
721 * The iterator is const, it is not changed.
722 *@param s Iterator from any compatible FBasicString to copy data from.
723 */
718 void append( const const_iterator &s ) 724 void append( const const_iterator &s )
719 { 725 {
720 if( !s.isValid() ) 726 if( !s.isValid() )
@@ -731,11 +737,24 @@ namespace Bu
731 } 737 }
732 } 738 }
733 739
740 /**
741 * Append data to this FString using the passed in iterator as a base.
742 * The iterator is const, it is not changed.
743 *@param s Iterator from any compatible FBasicString to copy data from.
744 */
734 void append( const iterator &s ) // I get complainst without this one 745 void append( const iterator &s ) // I get complainst without this one
735 { 746 {
736 append( const_iterator( s ) ); 747 append( const_iterator( s ) );
737 } 748 }
738 749
750 /**
751 * Append data to this FString using the passed in iterator as a base,
752 * and copy data until the ending iterator is reached. The character
753 * at the ending iterator is not copied.
754 * The iterators are const, they are not changed.
755 *@param s Iterator from any compatible FBasicString to copy data from.
756 *@param e Iterator to stop copying at.
757 */
739 void append( const const_iterator &s, const const_iterator &e ) 758 void append( const const_iterator &s, const const_iterator &e )
740 { 759 {
741 if( !s.isValid() ) 760 if( !s.isValid() )
@@ -885,10 +904,6 @@ namespace Bu
885 } 904 }
886 905
887 /** 906 /**
888 *@todo void prepend( const chr &cData )
889 */
890
891 /**
892 * Clear all data from the string. 907 * Clear all data from the string.
893 */ 908 */
894 void clear() 909 void clear()
@@ -1079,7 +1094,7 @@ namespace Bu
1079 1094
1080 /** 1095 /**
1081 * Plus equals operator for FString. 1096 * Plus equals operator for FString.
1082 *@param pData (const MyType &) The FString to append to your FString. 1097 *@param rSrc (const MyType &) The FString to append to your FString.
1083 */ 1098 */
1084 MyType &operator+=( const MyType &rSrc ) 1099 MyType &operator+=( const MyType &rSrc )
1085 { 1100 {
@@ -1093,7 +1108,7 @@ namespace Bu
1093 1108
1094 /** 1109 /**
1095 * Plus equals operator for FString. 1110 * Plus equals operator for FString.
1096 *@param pData (const chr) The character to append to your FString. 1111 *@param cData (const chr) The character to append to your FString.
1097 */ 1112 */
1098 MyType &operator+=( const chr cData ) 1113 MyType &operator+=( const chr cData )
1099 { 1114 {
@@ -1603,7 +1618,8 @@ namespace Bu
1603 1618
1604 /** 1619 /**
1605 * Find the index of the first occurrance of cChar 1620 * Find the index of the first occurrance of cChar
1606 *@param sText (const chr *) The string to search for. 1621 *@param cChar The character to search for.
1622 *@param iStart The position in the string to start searching from.
1607 *@returns (long) The index of the first occurrance. -1 for not found. 1623 *@returns (long) The index of the first occurrance. -1 for not found.
1608 */ 1624 */
1609 long findIdx( const chr cChar, long iStart=0 ) const 1625 long findIdx( const chr cChar, long iStart=0 ) const
@@ -1619,8 +1635,9 @@ namespace Bu
1619 1635
1620 /** 1636 /**
1621 * Find the index of the first occurrance of sText 1637 * Find the index of the first occurrance of sText
1622 *@param cChar (const chr) The character to search for. 1638 *@param sText The null-terminated string to search for.
1623 *@returns (long) The index of the first occurrance. -1 for not found. 1639 *@param iStart The position in the string to start searching from.
1640 *@returns The index of the first occurrance. -1 for not found.
1624 */ 1641 */
1625 long findIdx( const chr *sText, long iStart=0 ) const 1642 long findIdx( const chr *sText, long iStart=0 ) const
1626 { 1643 {