Index: src/OFDataArray.h ================================================================== --- src/OFDataArray.h +++ src/OFDataArray.h @@ -50,11 +50,11 @@ + (instancetype)dataArray; /*! * @brief Creates a new OFDataArray whose items all have the same size. * - * @param itemSize The size of each element in the OFDataArray + * @param itemSize The size of a single element in the OFDataArray * @return A new autoreleased OFDataArray */ + (instancetype)dataArrayWithItemSize: (size_t)itemSize; /*! @@ -95,11 +95,11 @@ /*! * @brief Initializes an already allocated OFDataArray whose items all have the * same size. * - * @param itemSize The size of each element in the OFDataArray + * @param itemSize The size of a single element in the OFDataArray * @return An initialized OFDataArray */ - initWithItemSize: (size_t)itemSize; /*! @@ -144,13 +144,13 @@ * @return The number of items in the OFDataArray */ - (size_t)count; /*! - * @brief Returns the size of each item in the OFDataArray in bytes. + * @brief Returns the size of a single item in the OFDataArray in bytes. * - * @return The size of each item in the OFDataArray in bytes + * @return The size of a single item in the OFDataArray in bytes */ - (size_t)itemSize; /*! * @brief Returns all items of the OFDataArray as a C array. Index: src/OFFile.h ================================================================== --- src/OFFile.h +++ src/OFFile.h @@ -48,11 +48,26 @@ /*! * @brief Creates a new OFFile with the specified path and mode. * * @param path The path to the file to open as a string - * @param mode The mode in which the file should be opened as a string + * @param mode The mode in which the file should be opened.@n + * Possible modes are: + * Mode | Description + * ---------------|------------------------------------- + * `r` | read-only + * `rb` | read-only, binary + * `r+` | read-write + * `rb+` or `r+b` | read-write, binary + * `w` | write-only, create, truncate + * `wb` | write-only, create, truncate, binary + * `w` | read-write, create, truncate + * `wb+` or `w+b` | read-write, create, truncate, binary + * `a` | write-only, create, append + * `ab` | write-only, create, append, binary + * `a+` | read-write, create, append + * `ab+` or `a+b` | read-write, create, append, binary * @return A new autoreleased OFFile */ + (instancetype)fileWithPath: (OFString*)path mode: (OFString*)mode; @@ -223,11 +238,26 @@ /*! * @brief Initializes an already allocated OFFile. * * @param path The path to the file to open as a string - * @param mode The mode in which the file should be opened as a string + * @param mode The mode in which the file should be opened.@n + * Possible modes are: + * Mode | Description + * ---------------|------------------------------------- + * `r` | read-only + * `rb` | read-only, binary + * `r+` | read-write + * `rb+` or `r+b` | read-write, binary + * `w` | write-only, create, truncate + * `wb` | write-only, create, truncate, binary + * `w` | read-write, create, truncate + * `wb+` or `w+b` | read-write, create, truncate, binary + * `a` | write-only, create, append + * `ab` | write-only, create, append, binary + * `a+` | read-write, create, append + * `ab+` or `a+b` | read-write, create, append, binary * @return An initialized OFFile */ - initWithPath: (OFString*)path mode: (OFString*)mode; Index: src/OFMutableArray.h ================================================================== --- src/OFMutableArray.h +++ src/OFMutableArray.h @@ -19,11 +19,11 @@ #ifdef OF_HAVE_BLOCKS typedef id (^of_array_replace_block_t)(id obj, size_t idx, BOOL *stop); #endif /*! - * @brief An abstract class for storing, adding and removing objects in anr + * @brief An abstract class for storing, adding and removing objects in an * array. */ @interface OFMutableArray: OFArray /*! * @brief Adds an object to the end of the array. Index: src/OFSeekableStream.h ================================================================== --- src/OFSeekableStream.h +++ src/OFSeekableStream.h @@ -37,14 +37,17 @@ @interface OFSeekableStream: OFStream /*! * @brief Seeks to the specified absolute offset. * * @param offset The offset in bytes - * @param whence From where to seek. Possible values are: - * * 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. + * @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 */ - (void)seekToOffset: (off_t)offset whence: (int)whence; /*! @@ -54,13 +57,16 @@ * * Override this with this method with your actual seek implementation when * subclassing! * * @param offset The offset to seek to - * @param whence From where to seek. Possible values are: - * * 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. + * @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 */ - (void)lowlevelSeekToOffset: (off_t)offset whence: (int)whence; @end Index: src/OFString.h ================================================================== --- src/OFString.h +++ src/OFString.h @@ -640,13 +640,15 @@ /*! * @brief Returns the range of the string. * * @param string The string to search - * @param options Options modifying search behaviour. - * Possible values: - * * OF_STRING_SEARCH_BACKWARDS + * @param options Options modifying search behaviour.@n + * Possible values are: + * 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_range_t)rangeOfString: (OFString*)string options: (int)options; @@ -653,13 +655,15 @@ /*! * @brief Returns the range of the string in the specified range. * * @param string The string to search - * @param options Options modifying search behaviour. - * Possible values: - * * OF_STRING_SEARCH_BACKWARDS + * @param options Options modifying search behaviour.@n + * Possible values are: + * 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_range_t)rangeOfString: (OFString*)string @@ -740,11 +744,11 @@ * 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. - * Possible values: + * Possible values are: * * None yet * @param range The range in which to replace the string * @return A new string with the occurrences of the specified string replaced */ - (OFString*)stringByReplacingOccurrencesOfString: (OFString*)string @@ -825,13 +829,15 @@ /*! * @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. - * Possible values: - * * OF_STRING_SKIP_EMPTY + * @param options Options according to which the string should be separated.@n + * Possible values are: + * Value | Description + * ---------------------|---------------------- + * OF_STRING_SKIP_EMPTY | Skip empty components * @return An autoreleased OFArray with the separated string */ - (OFArray*)componentsSeparatedByString: (OFString*)delimiter options: (int)options;