@@ -43,11 +43,11 @@ @optional #endif /** * \brief This callback is called when a stream did get ready for reading. * - * NOTE: When -[tryReadLine] or -[tryReadTillDelimiter:] has been called on the + * \note When \ref tryReadLine or \ref tryReadTillDelimiter: has been called on * the stream, this callback will not be called again until new data has * been received, even though there is still data in the cache. The reason * for this is to prevent spinning in a loop when there is an incomplete * string in the cache. Once the string is complete, the callback will be * called again if there is data in the cache. @@ -72,11 +72,11 @@ @end /** * \brief A class that can observe multiple streams at once. * - * Note: Currently, Win32 can only observe sockets and not files! + * \note Currently, Win32 can only observe sockets and not files! */ @interface OFStreamObserver: OFObject { OFMutableArray *readStreams; OFMutableArray *writeStreams; @@ -123,12 +123,12 @@ * This is also used to observe a listening socket for incoming connections, * which then triggers a read event for the observed stream. * * It is recommended that the stream you add is set to non-blocking mode. * - * If there is an -[observe] call blocking, it will be canceled. The reason for - * this is to prevent blocking even though the new added stream is ready. + * If there is an \ref observe call blocking, it will be canceled. The reason + * for this is to prevent blocking even though the new added stream is ready. * * \param stream The stream to observe for reading */ - (void)addStreamForReading: (OFStream*)stream; @@ -135,32 +135,32 @@ /** * \brief Adds a stream to observe for writing. * * It is recommended that the stream you add is set to non-blocking mode. * - * If there is an -[observe] call blocking, it will be canceled. The reason for - * this is to prevent blocking even though the new added stream is ready. + * If there is an \ref observe call blocking, it will be canceled. The reason + * for this is to prevent blocking even though the new added stream is ready. * * \param stream The stream to observe for writing */ - (void)addStreamForWriting: (OFStream*)stream; /** * \brief Removes a stream to observe for reading. * - * If there is an -[observe] call blocking, it will be canceled. The reason for - * this is to prevent the removed stream from still being observed. + * If there is an \ref observe call blocking, it will be canceled. The reason + * for this is to prevent the removed stream from still being observed. * * \param stream The stream to remove from observing for reading */ - (void)removeStreamForReading: (OFStream*)stream; /** * \brief Removes a stream to observe for writing. * - * If there is an -[observe] call blocking, it will be canceled. The reason for - * this is to prevent the removed stream from still being observed. + * If there is an \ref observe call blocking, it will be canceled. The reason + * for this is to prevent the removed stream from still being observed. * * \param stream The stream to remove from observing for writing */ - (void)removeStreamForWriting: (OFStream*)stream;