@@ -189,27 +189,27 @@ + (instancetype)stringWithUTF16String: (const of_char16_t*)string length: (size_t)length; /*! * @brief Creates a new OFString from a UTF-16 encoded string, assuming the - * specified byte order if no BOM is found. + * specified byte order if no byte order mark is found. * * @param string The UTF-16 string - * @param byteOrder The byte order to assume if there is no BOM + * @param byteOrder The byte order to assume if there is no byte order mark * @return A new autoreleased OFString */ + (instancetype)stringWithUTF16String: (const of_char16_t*)string byteOrder: (of_byte_order_t)byteOrder; /*! * @brief Creates a new OFString from a UTF-16 encoded string with the - * specified length, assuming the specified byte order if no BOM is - * found. + * specified length, assuming the specified byte order if no byte order + * mark is found. * * @param string The UTF-16 string * @param length The length of the UTF-16 string - * @param byteOrder The byte order to assume if there is no BOM + * @param byteOrder The byte order to assume if there is no byte order mark * @return A new autoreleased OFString */ + (instancetype)stringWithUTF16String: (const of_char16_t*)string length: (size_t)length byteOrder: (of_byte_order_t)byteOrder; @@ -233,27 +233,27 @@ + (instancetype)stringWithUTF32String: (const of_char32_t*)string length: (size_t)length; /*! * @brief Creates a new OFString from a UTF-32 encoded string, assuming the - * specified byte order if no BOM is found. + * specified byte order if no byte order mark is found. * * @param string The UTF-32 string - * @param byteOrder The byte order to assume if there is no BOM + * @param byteOrder The byte order to assume if there is no byte order mark * @return A new autoreleased OFString */ + (instancetype)stringWithUTF32String: (const of_char32_t*)string byteOrder: (of_byte_order_t)byteOrder; /*! * @brief Creates a new OFString from a UTF-32 encoded string with the - * specified length, assuming the specified byte order if no BOM is - * found. + * specified length, assuming the specified byte order if no byte order + * mark is found. * * @param string The UTF-32 string * @param length The length of the UTF-32 string - * @param byteOrder The byte order to assume if there is no BOM + * @param byteOrder The byte order to assume if there is no byte order mark * @return A new autoreleased OFString */ + (instancetype)stringWithUTF32String: (const of_char32_t*)string length: (size_t)length byteOrder: (of_byte_order_t)byteOrder; @@ -430,27 +430,27 @@ - initWithUTF16String: (const of_char16_t*)string length: (size_t)length; /*! * @brief Initializes an already allocated OFString with a UTF-16 string, - * assuming the specified byte order if no BOM is found. + * assuming the specified byte order if no byte order mark is found. * * @param string The UTF-16 string - * @param byteOrder The byte order to assume if there is no BOM + * @param byteOrder The byte order to assume if there is no byte order mark * @return An initialized OFString */ - initWithUTF16String: (const of_char16_t*)string byteOrder: (of_byte_order_t)byteOrder; /*! * @brief Initializes an already allocated OFString with a UTF-16 string with - * the specified length, assuming the specified byte order if no BOM is - * found. + * the specified length, assuming the specified byte order if no byte + * order mark is found. * * @param string The UTF-16 string * @param length The length of the UTF-16 string - * @param byteOrder The byte order to assume if there is no BOM + * @param byteOrder The byte order to assume if there is no byte order mark * @return An initialized OFString */ - initWithUTF16String: (const of_char16_t*)string length: (size_t)length byteOrder: (of_byte_order_t)byteOrder; @@ -474,27 +474,27 @@ - initWithUTF32String: (const of_char32_t*)string length: (size_t)length; /*! * @brief Initializes an already allocated OFString with a UTF-32 string, - * assuming the specified byte order if no BOM is found. + * assuming the specified byte order if no byte order mark is found. * * @param string The UTF-32 string - * @param byteOrder The byte order to assume if there is no BOM + * @param byteOrder The byte order to assume if there is no byte order mark * @return An initialized OFString */ - initWithUTF32String: (const of_char32_t*)string byteOrder: (of_byte_order_t)byteOrder; /*! * @brief Initializes an already allocated OFString with a UTF-32 string with - * the specified length, assuming the specified byte order if no BOM is - * found. + * the specified length, assuming the specified byte order if no byte + * order mark is found. * * @param string The UTF-32 string * @param length The length of the UTF-32 string - * @param byteOrder The byte order to assume if there is no BOM + * @param byteOrder The byte order to assume if there is no byte order mark * @return An initialized OFString */ - initWithUTF32String: (const of_char32_t*)string length: (size_t)length byteOrder: (of_byte_order_t)byteOrder; @@ -694,25 +694,25 @@ /*! * @brief Returns the range of the first occurrence of the string. * * @param string The string to search * @return The range of the first occurrence of the string or a range with - * OF_NOT_FOUND as start position if it was not found + * `OF_NOT_FOUND` as start position if it was not found */ - (of_range_t)rangeOfString: (OFString*)string; /*! * @brief Returns the range of the string. * * @param string The string to search * @param options Options modifying search behaviour.@n * Possible values are: - * Value | Description - * ---------------------------|------------------------------- - * OF_STRING_SEARCH_BACKWARDS | Search backwards in the string + * Value | Description + * -----------------------------|------------------------------- + * `OF_STRING_SEARCH_BACKWARDS` | Search backwards in the string * @return The range of the first occurrence of the string or a range with - * OF_NOT_FOUND as start position if it was not found + * `OF_NOT_FOUND` as start position if it was not found */ - (of_range_t)rangeOfString: (OFString*)string options: (int)options; /*! @@ -719,16 +719,16 @@ * @brief Returns the range of the string in the specified range. * * @param string The string to search * @param options Options modifying search behaviour.@n * Possible values are: - * Value | Description - * ---------------------------|------------------------------- - * OF_STRING_SEARCH_BACKWARDS | Search backwards in the string + * Value | Description + * -----------------------------|------------------------------- + * `OF_STRING_SEARCH_BACKWARDS` | Search backwards in the string * @param range The range in which to search * @return The range of the first occurrence of the string or a range with - * OF_NOT_FOUND as start position if it was not found + * `OF_NOT_FOUND` as start position if it was not found */ - (of_range_t)rangeOfString: (OFString*)string options: (int)options range: (of_range_t)range; @@ -893,13 +893,13 @@ * @brief Separates an OFString into an OFArray of OFStrings. * * @param delimiter The delimiter for separating * @param options Options according to which the string should be separated.@n * Possible values are: - * Value | Description - * ---------------------|---------------------- - * OF_STRING_SKIP_EMPTY | Skip empty components + * Value | Description + * -----------------------|---------------------- + * `OF_STRING_SKIP_EMPTY` | Skip empty components * @return An autoreleased OFArray with the separated string */ - (OFArray*)componentsSeparatedByString: (OFString*)delimiter options: (int)options;