@@ -14,11 +14,11 @@ #import "OFObject.h" @class OFString; /** - * An exception indicating an object could not be allocated. + * \brief An exception indicating an object could not be allocated. * * This exception is preallocated, as if there's no memory, no exception can * be allocated of course. That's why you shouldn't and even can't deallocate * it. * @@ -39,11 +39,14 @@ */ - (OFString*)string; @end /** - * The OFException class is the base class for all exceptions in ObjFW. + * \brief The base class for all exceptions in ObjFW + * + * The OFException class is the base class for all exceptions in ObjFW, except + * the OFAllocFailedException. * * IMPORTANT: Exceptions do NOT use OFAutoreleasePools and can't be autoreleased * either! You have to make sure to dealloc the exception in your \@catch block! */ @interface OFException: OFObject @@ -78,11 +81,11 @@ */ - (OFString*)string; @end /** - * An OFException indicating there is not enough memory available. + * \brief An exception indicating there is not enough memory available. */ @interface OFOutOfMemoryException: OFException { size_t req_size; } @@ -110,17 +113,18 @@ */ - (size_t)requestedSize; @end /** - * An OFException indicating that a mutation was detected while enumerating. + * \brief An exception indicating that a mutation was detected while + * enumerating. */ @interface OFEnumerationMutationException: OFException {} @end /** - * An OFException indicating the given memory is not part of the object. + * \brief An exception indicating the given memory is not part of the object. */ @interface OFMemoryNotPartOfObjectException: OFException { void *pointer; } @@ -148,11 +152,12 @@ */ - (void*)pointer; @end /** - * An OFException indicating that a method or part of it is not implemented. + * \brief An exception indicating that a method or part of it is not + * implemented. */ @interface OFNotImplementedException: OFException { SEL selector; } @@ -175,17 +180,17 @@ - initWithClass: (Class)class_ selector: (SEL)selector; @end /** - * An OFException indicating the given value is out of range. + * \brief An exception indicating the given value is out of range. */ @interface OFOutOfRangeException: OFException {} @end /** - * An OFException indicating that the argument is invalid for this method. + * \brief An exception indicating that the argument is invalid for this method. */ @interface OFInvalidArgumentException: OFException { SEL selector; } @@ -208,35 +213,36 @@ - initWithClass: (Class)class_ selector: (SEL)selector; @end /** - * An OFException indicating that the encoding is invalid for this object. + * \brief An exception indicating that the encoding is invalid for this object. */ @interface OFInvalidEncodingException: OFException {} @end /** - * An OFException indicating that the format is invalid. + * \brief An exception indicating that the format is invalid. */ @interface OFInvalidFormatException: OFException {} @end /** - * An OFException indicating that a parser encountered malformed or invalid XML. + * \brief An exception indicating that a parser encountered malformed or + * invalid XML. */ @interface OFMalformedXMLException: OFException {} @end /** - * An OFException indicating that initializing something failed. + * \brief An exception indicating that initializing something failed. */ @interface OFInitializationFailedException: OFException {} @end /** - * An OFException indicating the file couldn't be opened. + * \brief An exception indicating the file couldn't be opened. */ @interface OFOpenFileFailedException: OFException { OFString *path; OFString *mode; @@ -280,11 +286,11 @@ */ - (OFString*)mode; @end /** - * An OFException indicating a read or write to the file failed. + * \brief An exception indicating a read or write to the file failed. */ @interface OFReadOrWriteFailedException: OFException { size_t req_size; int err; @@ -318,23 +324,23 @@ */ - (size_t)requestedSize; @end /** - * An OFException indicating a read on the file failed. + * \brief An exception indicating a read on a file failed. */ @interface OFReadFailedException: OFReadOrWriteFailedException {} @end /** - * An OFException indicating a write to the file failed. + * \brief An exception indicating a write to a file failed. */ @interface OFWriteFailedException: OFReadOrWriteFailedException {} @end /** - * An OFException indicating that changing the mode of the file failed. + * \brief An exception indicating that changing the mode of a file failed. */ @interface OFChangeFileModeFailedException: OFException { OFString *path; mode_t mode; @@ -379,11 +385,11 @@ - (mode_t)mode; @end #ifndef _WIN32 /** - * An OFException indicating that changing the owner of the file failed. + * \brief An exception indicating that changing the owner of a file failed. */ @interface OFChangeFileOwnerFailedException: OFException { OFString *path; uid_t owner; @@ -438,11 +444,11 @@ - (gid_t)group; @end #endif /** - * An OFException indicating that renaming a file failed. + * \brief An exception indicating that renaming a file failed. */ @interface OFRenameFileFailedException: OFException { OFString *from; OFString *to; @@ -486,11 +492,11 @@ */ - (OFString*)to; @end /** - * An OFException indicating that deleting a file failed. + * \brief An exception indicating that deleting a file failed. */ @interface OFDeleteFileFailedException: OFException { OFString *path; int err; @@ -525,11 +531,11 @@ - (OFString*)path; @end #ifndef _WIN32 /** - * An OFException indicating that creating a link failed. + * \brief An exception indicating that creating a link failed. */ @interface OFLinkFailedException: OFException { OFString *src; OFString *dest; @@ -573,11 +579,11 @@ */ - (OFString*)destination; @end /** - * An OFException indicating that creating a symlink failed. + * \brief An exception indicating that creating a symlink failed. */ @interface OFSymlinkFailedException: OFException { OFString *src; OFString *dest; @@ -622,30 +628,30 @@ - (OFString*)destination; @end #endif /** - * An OFException indicating that setting an option failed. + * \brief An exception indicating that setting an option failed. */ @interface OFSetOptionFailedException: OFException {} @end /** - * An OFException indicating a socket is not connected or bound. + * \brief An exception indicating a socket is not connected or bound. */ @interface OFNotConnectedException: OFException {} @end /** - * An OFException indicating an attempt to connect or bind an already connected - * or bound socket. + * \brief An exception indicating an attempt to connect or bind an already + * connected or bound socket. */ @interface OFAlreadyConnectedException: OFException {} @end /** - * An OFException indicating the translation of an address failed. + * \brief An exception indicating the translation of an address failed. */ @interface OFAddressTranslationFailedException: OFException { OFString *node; OFString *service; @@ -689,11 +695,11 @@ */ - (OFString*)service; @end /** - * An OFException indicating that the connection could not be established. + * \brief An exception indicating that the connection could not be established. */ @interface OFConnectionFailedException: OFException { OFString *node; OFString *service; @@ -737,11 +743,11 @@ */ - (OFString*)service; @end /** - * An OFException indicating that binding the socket failed. + * \brief An exception indicating that binding the socket failed. */ @interface OFBindFailedException: OFException { OFString *node; OFString *service; @@ -795,11 +801,11 @@ */ - (int)family; @end /** - * An OFException indicating that listening on the socket failed. + * \brief An exception indicating that listening on the socket failed. */ @interface OFListenFailedException: OFException { int backlog; int err; @@ -833,11 +839,11 @@ */ - (int)backLog; @end /** - * An OFException indicating that accepting a connection failed. + * \brief An exception indicating that accepting a connection failed. */ @interface OFAcceptFailedException: OFException { int err; } @@ -847,27 +853,27 @@ */ - (int)errNo; @end /** - * An OFException indicating that joining the thread failed. + * \brief An exception indicating that joining the thread failed. */ @interface OFThreadJoinFailedException: OFException {} @end /** - * An OFException indicating that locking a mutex failed. + * \brief An exception indicating that locking a mutex failed. */ @interface OFMutexLockFailedException: OFException {} @end /** - * An OFException indicating that unlocking a mutex failed. + * \brief An exception indicating that unlocking a mutex failed. */ @interface OFMutexUnlockFailedException: OFException {} @end /** - * An OFException indicating that the hash has already been calculated. + * \brief An exception indicating that the hash has already been calculated. */ @interface OFHashAlreadyCalculatedException: OFException {} @end