@@ -23,76 +23,76 @@ #include #import "OFStream.h" -/** - * \brief A stream that supports seeking. +/*! + * @brief A stream that supports seeking. * - * \note If you want to subclass this, override lowlevelSeekToOffset:, + * @note If you want to subclass this, override lowlevelSeekToOffset:, * lowlevelSeekForwardWithOffset: and lowlevelSeekToOffsetRelativeToEnd:, * but nothing else. Those are not defined in the headers, but do the * actual work. OFSeekableStream uses those and makes them work together * with the caching of OFStream. If you override these methods without * the lowlevel prefix, you will break caching, get broken results * and seek to the wrong position! */ @interface OFSeekableStream: OFStream -/** - * \brief Seeks to the specified absolute offset. - * - * \param offset The offset in bytes - */ -- (void)seekToOffset: (off_t)offset; - -/** - * \brief Seeks to the specified offset, relative to the current location. - * - * \param offset The offset relative to the current location - * \return The absolute offset - */ -- (off_t)seekForwardWithOffset: (off_t)offset; - -/** - * \brief Seeks to the specified offset, relative to the end of the stream. - * - * \param offset The offset relative to the end of the stream - * \return The absolute offset - */ -- (off_t)seekToOffsetRelativeToEnd: (off_t)offset; - -/** - * \brief Seek the stream on the lowlevel. - * - * \warning Do not call this directly! - * - * Override this with this method with your actual seek implementation when - * subclassing! - * - * \param offset The offset to seek to - */ -- (void)lowlevelSeekToOffset: (off_t)offset; - -/** - * \brief Seek the stream on the lowlevel. - * - * \warning Do not call this directly! - * - * Override this with this method with your actual seek implementation when - * subclassing! - * - * \param offset The offset to seek forward to - */ -- (off_t)lowlevelSeekForwardWithOffset: (off_t)offset; - -/** - * \brief Seek the stream on the lowlevel. - * - * \warning Do not call this directly! - * - * Override this with this method with your actual seek implementation when - * subclassing! - * - * \param offset The offset to seek to, relative to the end +/*! + * @brief Seeks to the specified absolute offset. + * + * @param offset The offset in bytes + */ +- (void)seekToOffset: (off_t)offset; + +/*! + * @brief Seeks to the specified offset, relative to the current location. + * + * @param offset The offset relative to the current location + * @return The absolute offset + */ +- (off_t)seekForwardWithOffset: (off_t)offset; + +/*! + * @brief Seeks to the specified offset, relative to the end of the stream. + * + * @param offset The offset relative to the end of the stream + * @return The absolute offset + */ +- (off_t)seekToOffsetRelativeToEnd: (off_t)offset; + +/*! + * @brief Seek the stream on the lowlevel. + * + * @warning Do not call this directly! + * + * Override this with this method with your actual seek implementation when + * subclassing! + * + * @param offset The offset to seek to + */ +- (void)lowlevelSeekToOffset: (off_t)offset; + +/*! + * @brief Seek the stream on the lowlevel. + * + * @warning Do not call this directly! + * + * Override this with this method with your actual seek implementation when + * subclassing! + * + * @param offset The offset to seek forward to + */ +- (off_t)lowlevelSeekForwardWithOffset: (off_t)offset; + +/*! + * @brief Seek the stream on the lowlevel. + * + * @warning Do not call this directly! + * + * Override this with this method with your actual seek implementation when + * subclassing! + * + * @param offset The offset to seek to, relative to the end */ - (off_t)lowlevelSeekToOffsetRelativeToEnd: (off_t)offset; @end