Index: src/OFArray.h ================================================================== --- src/OFArray.h +++ src/OFArray.h @@ -203,25 +203,25 @@ */ - (id*)objects; /*! * @brief Returns the index of the first object that is equivalent to the - * specified object or OF_NOT_FOUND if it was not found. + * specified object or `OF_NOT_FOUND` if it was not found. * * @param object The object whose index is returned * @return The index of the first object equivalent to the specified object - * or OF_NOT_FOUND if it was not found + * or `OF_NOT_FOUND` if it was not found */ - (size_t)indexOfObject: (id)object; /*! * @brief Returns the index of the first object that has the same address as the - * specified object or OF_NOT_FOUND if it was not found. + * specified object or `OF_NOT_FOUND` if it was not found. * * @param object The object whose index is returned * @return The index of the first object that has the same aaddress as - * the specified object or OF_NOT_FOUND if it was not found + * the specified object or `OF_NOT_FOUND` if it was not found */ - (size_t)indexOfObjectIdenticalTo: (id)object; /*! * @brief Checks whether the array contains an object with the specified @@ -273,13 +273,13 @@ * @brief Creates a string by joining all objects of the array. * * @param separator The string with which the objects should be joined * @param options Options according to which the objects should be joined.@n * Possible values are: - * Value | Description - * ---------------------|---------------------- - * OF_ARRAY_SKIP_EMPTY | Skip empty components + * Value | Description + * ----------------------|---------------------- + * `OF_ARRAY_SKIP_EMPTY` | Skip empty components * @return A string containing all objects joined by the separator */ - (OFString*)componentsJoinedByString: (OFString*)separator options: (int)options; @@ -300,13 +300,13 @@ * * @param separator The string with which the objects should be joined * @param selector The selector to perform on the objects * @param options Options according to which the objects should be joined.@n * Possible values are: - * Value | Description - * ---------------------|---------------------- - * OF_ARRAY_SKIP_EMPTY | Skip empty components + * Value | Description + * ----------------------|---------------------- + * `OF_ARRAY_SKIP_EMPTY` | Skip empty components * @return A string containing all objects joined by the separator */ - (OFString*)componentsJoinedByString: (OFString*)separator usingSelector: (SEL)selector options: (int)options; @@ -339,13 +339,13 @@ /*! * @brief Returns a sorted copy of the array. * * @param options The options to use when sorting the array.@n * Possible values are: - * Value | Description - * -------------------------|------------------------- - * OF_ARRAY_SORT_DESCENDING | Sort in descending order + * Value | Description + * ---------------------------|------------------------- + * `OF_ARRAY_SORT_DESCENDING` | Sort in descending order * @return A sorted copy of the array */ - (OFArray*)sortedArrayWithOptions: (int)options; /*! Index: src/OFMutableArray.h ================================================================== --- src/OFMutableArray.h +++ src/OFMutableArray.h @@ -182,11 +182,11 @@ * * @param options The options to use when sorting the array.@n * Possible values are: * Value | Description * ---------------------------|------------------------- - * OF_SORT_OPTIONS_DESCENDING | Sort in descending order + * `OF_ARRAY_SORT_DESCENDING` | Sort in descending order */ - (void)sortWithOptions: (int)options; /*! * @brief Reverts the order of the objects in the array. Index: src/OFSeekableStream.h ================================================================== --- src/OFSeekableStream.h +++ src/OFSeekableStream.h @@ -39,15 +39,15 @@ * @brief Seeks to the specified absolute offset. * * @param offset The offset in bytes * @param whence From where to seek.@n * Possible values are: - * Value | Description - * ---------|--------------------------------------- - * SEEK_SET | Seek to the specified byte - * SEEK_CUR | Seek to the current location + offset - * SEEK_END | Seek to the end of the stream + offset + * Value | Description + * -----------|--------------------------------------- + * `SEEK_SET` | Seek to the specified byte + * `SEEK_CUR` | Seek to the current location + offset + * `SEEK_END` | Seek to the end of the stream + offset * @return The new offset form the start of the file */ - (off_t)seekToOffset: (off_t)offset whence: (int)whence; @@ -60,15 +60,15 @@ * subclassing! * * @param offset The offset to seek to * @param whence From where to seek.@n * Possible values are: - * Value | Description - * ---------|--------------------------------------- - * SEEK_SET | Seek to the specified byte - * SEEK_CUR | Seek to the current location + offset - * SEEK_END | Seek to the end of the stream + offset + * Value | Description + * -----------|--------------------------------------- + * `SEEK_SET` | Seek to the specified byte + * `SEEK_CUR` | Seek to the current location + offset + * `SEEK_END` | Seek to the end of the stream + offset * @return The new offset from the start of the file */ - (off_t)lowlevelSeekToOffset: (off_t)offset whence: (int)whence; @end Index: src/OFString.h ================================================================== --- src/OFString.h +++ src/OFString.h @@ -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;