@@ -77,15 +77,15 @@ OFStringEncodingISO8859_15, /** Windows-1251 */ OFStringEncodingWindows1251, /** Windows-1252 */ OFStringEncodingWindows1252, - /** Codepage 437 */ + /** Code page 437 */ OFStringEncodingCodepage437, - /** Codepage 850 */ + /** Code page 850 */ OFStringEncodingCodepage850, - /** Codepage 858 */ + /** Code page 858 */ OFStringEncodingCodepage858, /** Mac OS Roman */ OFStringEncodingMacRoman, /** KOI8-R */ OFStringEncodingKOI8R, @@ -132,11 +132,11 @@ * @brief A class for handling strings. */ @interface OFString: OFObject /** - * @brief The length of the string in Unicode codepoints. + * @brief The length of the string in Unicode code points. */ @property (readonly, nonatomic) size_t length; /** * @brief The OFString as a UTF-8 encoded C string. @@ -305,11 +305,11 @@ /** * @brief Creates a new OFString from a UTF-8 encoded C string without copying * the string, if possible. * * If initialization fails for whatever reason, the passed C string is *not* - * free'd if `freeWhenDone` is true. + * freed if `freeWhenDone` is true. * * @note OFMutableString always creates a copy! * * @param UTF8String A UTF-8 encoded C string to initialize the OFString with * @param freeWhenDone Whether to free the C string when the OFString gets @@ -323,11 +323,11 @@ /** * @brief Creates a new OFString from a UTF-8 encoded C string with the * specified length without copying the string, if possible. * * If initialization fails for whatever reason, the passed C string is *not* - * free'd if `freeWhenDone` is true. + * freed if `freeWhenDone` is true. * * @note OFMutableString always creates a copy! * * @param UTF8String A UTF-8 encoded C string to initialize the OFString with * @param UTF8StringLength The length of the UTF-8 encoded C string @@ -529,13 +529,13 @@ /** * @brief Creates a new OFString with the contents of the specified IRI. * * If the IRI's scheme is file, it tries UTF-8 encoding. * - * If the IRI's scheme is http(s), it tries to detect the encoding from the HTTP - * headers. If it could not detect the encoding using the HTTP headers, it tries - * UTF-8. + * If the IRI's scheme is `http` or `https`, it tries to detect the encoding + * from the HTTP headers. If it could not detect the encoding using the HTTP + * headers, it tries UTF-8. * * @param IRI The IRI to the contents for the string * @return A new autoreleased OFString * @throw OFInvalidEncodingException The string is not in the expected encoding */ @@ -585,11 +585,11 @@ /** * @brief Initializes an already allocated OFString from an UTF-8 encoded C * string without copying the string, if possible. * * If initialization fails for whatever reason, the passed C string is *not* - * free'd if `freeWhenDone` is true. + * freed if `freeWhenDone` is true. * * @note OFMutableString always creates a copy! * * @param UTF8String A UTF-8 encoded C string to initialize the OFString with * @param freeWhenDone Whether to free the C string when it is not needed @@ -604,11 +604,11 @@ * @brief Initializes an already allocated OFString from an UTF-8 encoded C * string with the specified length without copying the string, if * possible. * * If initialization fails for whatever reason, the passed C string is *not* - * free'd if `freeWhenDone` is true. + * freed if `freeWhenDone` is true. * * @note OFMutableString always creates a copy! * * @param UTF8String A UTF-8 encoded C string to initialize the OFString with * @param UTF8StringLength The length of the UTF-8 encoded C string @@ -830,13 +830,13 @@ * @brief Initializes an already allocated OFString with the contents of the * specified IRI. * * If the IRI's scheme is file, it tries UTF-8 encoding. * - * If the IRI's scheme is http(s), it tries to detect the encoding from the HTTP - * headers. If it could not detect the encoding using the HTTP headers, it tries - * UTF-8. + * If the IRI's scheme is `http` or `https`, it tries to detect the encoding + * from the HTTP headers. If it could not detect the encoding using the HTTP + * headers, it tries UTF-8. * * @param IRI The IRI to the contents for the string * @return An initialized OFString * @throw OFInvalidEncodingException The string is not in the expected encoding */ @@ -1003,11 +1003,11 @@ /** * @brief Returns the index of the first character from the set. * * @param characterSet The set of characters to search for - * @param options Options modifying search behaviour + * @param options Options modifying search behavior * @return The index of the first occurrence of a character from the set or * `OFNotFound` if it was not found */ - (size_t)indexOfCharacterFromSet: (OFCharacterSet *)characterSet options: (OFStringSearchOptions)options; @@ -1014,11 +1014,11 @@ /** * @brief Returns the index of the first character from the set. * * @param characterSet The set of characters to search for - * @param options Options modifying search behaviour + * @param options Options modifying search behavior * @param range The range in which to search * @return The index of the first occurrence of a character from the set or * `OFNotFound` if it was not found */ - (size_t)indexOfCharacterFromSet: (OFCharacterSet *)characterSet @@ -1043,11 +1043,11 @@ /** * @brief Creates a substring from the beginning to the specified index. * * @param idx The index at which the substring should end, exclusive - * @return The subtring from the beginning to the specified index + * @return The substring from the beginning to the specified index */ - (OFString *)substringToIndex: (size_t)idx; /** * @brief Creates a substring with the specified range. @@ -1149,11 +1149,11 @@ * @brief Creates a new string by replacing the occurrences of the specified * string in the specified range with the specified replacement. * * @param string The string to replace * @param replacement The string with which it should be replaced - * @param options Options modifying search behaviour. + * @param options Options modifying search behavior. * Possible values are: * * None yet, pass 0 * @param range The range in which to replace the string * @return A new string with the occurrences of the specified string replaced */