@@ -37,23 +37,27 @@ @property (readonly) int whence; @property (readonly) int errNo; #endif /** + * \brief Creates a new, autoreleased seek failed exception. + * + * \param class_ The class of the object which caused the exception * \param stream The stream for which seeking failed * \param offset The offset to which seeking failed * \param whence To what the offset is relative - * \return A new seek failed exception + * \return A new, autoreleased seek failed exception */ + (instancetype)exceptionWithClass: (Class)class_ stream: (OFSeekableStream*)stream offset: (off_t)offset whence: (int)whence; /** - * Initializes an already allocated seek failed exception. + * \brief Initializes an already allocated seek failed exception. * + * \param class_ The class of the object which caused the exception * \param stream The stream for which seeking failed * \param offset The offset to which seeking failed * \param whence To what the offset is relative * \return An initialized seek failed exception */ @@ -61,24 +65,32 @@ stream: (OFSeekableStream*)stream offset: (off_t)offset whence: (int)whence; /** + * \brief Returns the stream for which seeking failed. + * * \return The stream for which seeking failed */ - (OFSeekableStream*)stream; /** + * \brief Returns the offset to which seeking failed. + * * \return The offset to which seeking failed */ - (off_t)offset; /** + * \brief Returns to what the offset is relative. + * * \return To what the offset is relative */ - (int)whence; /** + * \brief Returns the errno from when the exception was created. + * * \return The errno from when the exception was created */ - (int)errNo; @end