@@ -80,11 +80,11 @@ * @note If you want to subclass this, override * @ref lowlevelReadIntoBuffer:length:, @ref lowlevelWriteBuffer:length: * and @ref lowlevelIsAtEndOfStream, but nothing else, as those are are * the methods that do the actual work. OFStream uses those for all other * methods and does all the caching and other stuff for you. If you - * override these methods without the lowlevel prefix, you *will* break + * override these methods without the `lowlevel` prefix, you *will* break * caching and get broken results! */ @interface OFStream: OFObject < #ifdef OF_HAVE_SOCKETS OFReadyForReadingObserving, OFReadyForWritingObserving, @@ -143,11 +143,11 @@ - (void)readIntoBuffer: (void*)buffer exactLength: (size_t)length; #ifdef OF_HAVE_SOCKETS /*! - * @brief Asyncronously reads *at most* size bytes from the stream into a + * @brief Asynchronously reads *at most* size bytes from the stream into a * buffer. * * On network streams, this might read less than the specified number of bytes. * If you want to read exactly the specified number of bytes, use * @ref asyncReadIntoBuffer:exactLength:block:. Note that a read can even @@ -156,11 +156,11 @@ * * @note The stream must implement @ref fileDescriptorForReading and return a * valid file descriptor in order for this to work! * * @param buffer The buffer into which the data is read. - * The buffer must not be free'd before the async read completed! + * The buffer must not be freed before the async read completed! * @param length The length of the data that should be read at most. * The buffer *must* be *at least* this big! * @param target The target on which the selector should be called when the * data has been received. If the method returns true, it will be * called again with the same buffer and maximum length when more @@ -175,11 +175,11 @@ length: (size_t)length target: (id)target selector: (SEL)selector; /*! - * @brief Asyncronously reads exactly the specified length bytes from the + * @brief Asynchronously reads exactly the specified length bytes from the * stream into a buffer. * * Unlike @ref asyncReadIntoBuffer:length:target:selector:, this method does * not call the method when less than the specified length has been read - * instead, it waits until it got exactly the specified length, the stream has @@ -206,11 +206,11 @@ target: (id)target selector: (SEL)selector; # ifdef OF_HAVE_BLOCKS /*! - * @brief Asyncronously reads *at most* ref size bytes from the stream into a + * @brief Asynchronously reads *at most* ref size bytes from the stream into a * buffer. * * On network streams, this might read less than the specified number of bytes. * If you want to read exactly the specified number of bytes, use * @ref asyncReadIntoBuffer:exactLength:block:. Note that a read can even @@ -219,11 +219,11 @@ * * @note The stream must implement @ref fileDescriptorForReading and return a * valid file descriptor in order for this to work! * * @param buffer The buffer into which the data is read. - * The buffer must not be free'd before the async read completed! + * The buffer must not be freed before the async read completed! * @param length The length of the data that should be read at most. * The buffer *must* be *at least* this big! * @param block The block to call when the data has been received. * If the block returns true, it will be called again with the same * buffer and maximum length when more data has been received. If @@ -233,11 +233,11 @@ - (void)asyncReadIntoBuffer: (void*)buffer length: (size_t)length block: (of_stream_async_read_block_t)block; /*! - * @brief Asyncronously reads exactly the specified length bytes from the + * @brief Asynchronously reads exactly the specified length bytes from the * stream into a buffer. * * Unlike @ref asyncReadIntoBuffer:length:block:, this method does not invoke * the block when less than the specified length has been read - instead, it * waits until it got exactly the specified length, the stream has ended or an @@ -607,11 +607,11 @@ */ - (nullable OFString*)readLineWithEncoding: (of_string_encoding_t)encoding; #ifdef OF_HAVE_SOCKETS /*! - * @brief Asyncronously reads until a newline, `\0`, end of stream or an + * @brief Asynchronously reads until a newline, `\0`, end of stream or an * exception occurs. * * @note The stream must implement @ref fileDescriptorForReading and return a * valid file descriptor in order for this to work! * @@ -626,11 +626,11 @@ */ - (void)asyncReadLineWithTarget: (id)target selector: (SEL)selector; /*! - * @brief Asyncronously reads with the specified encoding until a newline, + * @brief Asynchronously reads with the specified encoding until a newline, * `\0`, end of stream or an exception occurs. * * @note The stream must implement @ref fileDescriptorForReading and return a * valid file descriptor in order for this to work! * @@ -648,11 +648,11 @@ target: (id)target selector: (SEL)selector; # ifdef OF_HAVE_BLOCKS /*! - * @brief Asyncronously reads until a newline, `\0`, end of stream or an + * @brief Asynchronously reads until a newline, `\0`, end of stream or an * exception occurs. * * @note The stream must implement @ref fileDescriptorForReading and return a * valid file descriptor in order for this to work! * @@ -663,11 +663,11 @@ * block. */ - (void)asyncReadLineWithBlock: (of_stream_async_read_line_block_t)block; /*! - * @brief Asyncronously reads with the specified encoding until a newline, + * @brief Asynchronously reads with the specified encoding until a newline, * `\0`, end of stream or an exception occurs. * * @note The stream must implement @ref fileDescriptorForReading and return a * valid file descriptor in order for this to work! * @@ -682,12 +682,12 @@ block: (of_stream_async_read_line_block_t)block; # endif #endif /*! - * @brief Tries to read a line from the stream (see readLine) and returns `nil` - * if no complete line has been received yet. + * @brief Tries to read a line from the stream (see @ref readLine) and returns + * `nil` if no complete line has been received yet. * * @return The line that was read, autoreleased, or `nil` if the line is not * complete yet */ - (nullable OFString*)tryReadLine; @@ -748,11 +748,11 @@ */ - (nullable OFString*)tryReadTillDelimiter: (OFString*)delimiter encoding: (of_string_encoding_t)encoding; /*! - * @brief Returns a boolen whether writes are buffered. + * @brief Returns a boolean whether writes are buffered. * * @return A boolean whether writes are buffered */ - (bool)isWriteBuffered;