Index: src/OFApplication.h ================================================================== --- src/OFApplication.h +++ src/OFApplication.h @@ -28,10 +28,12 @@ { \ return of_application_main(&argc, &argv, [cls class]); \ } /*! + * @protocol OFApplicationDelegate OFApplication.h ObjFW/OFApplication.h + * * @brief A protocol for delegates of OFApplication. */ @protocol OFApplicationDelegate /*! * @brief A method which is called when the application was initialized and is @@ -95,10 +97,12 @@ - (void)applicationDidReceiveSIGUSR2; #endif @end /*! + * @class OFApplication OFApplication.h ObjFW/OFApplication.h + * * @brief A class which represents the application as an object. * * In order to create a new OFApplication, you should create a class conforming * to the optional @ref OFApplicationDelegate protocol and put * `OF_APPLICATION_DELEGATE(NameOfYourClass)` in the .m file of that class. The Index: src/OFArray.h ================================================================== --- src/OFArray.h +++ src/OFArray.h @@ -78,10 +78,12 @@ */ typedef id (^of_array_fold_block_t)(id left, id right); #endif /*! + * @class OFArray OFArray.h ObjFW/OFArray.h + * * @brief An abstract class for storing objects in an array. */ @interface OFArray: OFObject #ifdef OF_HAVE_PROPERTIES Index: src/OFAutoreleasePool.h ================================================================== --- src/OFAutoreleasePool.h +++ src/OFAutoreleasePool.h @@ -15,10 +15,12 @@ */ #import "OFObject.h" /*! + * @class OFAutoreleasePool OFAutoreleasePool.h ObjFW/OFAutoreleasePool.h + * * @brief A pool that keeps track of objects to release. * * The OFAutoreleasePool class is a class that keeps track of objects that will * be released when the autorelease pool is released. * Index: src/OFBigDataArray.h ================================================================== --- src/OFBigDataArray.h +++ src/OFBigDataArray.h @@ -15,10 +15,12 @@ */ #import "OFDataArray.h" /*! + * @class OFBigDataArray OFBigDataArray.h ObjFW/OFBigDataArray.h + * * @brief A class for storing arbitrary big data in an array. * * The OFBigDataArray class is a class for storing arbitrary data in an array * and is designed to store large hunks of data. Therefore, it allocates * memory in pages rather than a chunk of memory for each item. Index: src/OFBlock.h ================================================================== --- src/OFBlock.h +++ src/OFBlock.h @@ -17,10 +17,12 @@ #import "OFObject.h" #import "block.h" /*! + * @class OFBlock OFBlock.h ObjFW/OFBlock.h + * * @brief The class for all blocks, since all blocks are also objects. */ @interface OFBlock: OFObject @end Index: src/OFCollection.h ================================================================== --- src/OFCollection.h +++ src/OFCollection.h @@ -15,10 +15,12 @@ */ #import "OFEnumerator.h" /*! + * @protocol OFCollection OFCollection.h ObjFW/OFCollection.h + * * @brief A protocol with methods common for all collections. */ @protocol OFCollection #ifdef OF_HAVE_PROPERTIES @property (readonly) size_t count; Index: src/OFCondition.h ================================================================== --- src/OFCondition.h +++ src/OFCondition.h @@ -17,10 +17,12 @@ #import "OFMutex.h" @class OFDate; /*! + * @class OFCondition OFCondition.h ObjFW/OFCondition.h + * * @brief A class implementing a condition variable for thread synchronization. */ @interface OFCondition: OFMutex { of_condition_t _condition; Index: src/OFConstantString.h ================================================================== --- src/OFConstantString.h +++ src/OFConstantString.h @@ -26,13 +26,15 @@ } # endif #endif /*! + * @class OFConstantString OFConstantString.h ObjFW/OFConstantString.h + * * @brief A class for storing constant strings using the `@""` literal. */ @interface OFConstantString: OFString { char *_cString; unsigned int _cStringLength; } @end Index: src/OFCountedSet.h ================================================================== --- src/OFCountedSet.h +++ src/OFCountedSet.h @@ -30,10 +30,12 @@ typedef void (^of_counted_set_enumeration_block_t)(id object, size_t count, bool *stop); #endif /*! + * @class OFCountedSet OFCountedSet.h ObjFW/OFCountedSet.h + * * @brief An abstract class for a mutable unordered set of objects, counting how * often it contains an object. */ @interface OFCountedSet: OFMutableSet /*! Index: src/OFDataArray+Hashing.h ================================================================== --- src/OFDataArray+Hashing.h +++ src/OFDataArray+Hashing.h @@ -24,13 +24,10 @@ extern int _OFDataArray_Hashing_reference; #ifdef __cplusplus } #endif -/*! - * @brief A category which provides methods to calculate hashes for data arrays. - */ @interface OFDataArray (Hashing) /*! * @brief Returns the MD5 hash of the data array as an autoreleased OFString. * * @return The MD5 hash of the data array as an autoreleased OFString Index: src/OFDataArray+MessagePackValue.h ================================================================== --- src/OFDataArray+MessagePackValue.h +++ src/OFDataArray+MessagePackValue.h @@ -23,7 +23,12 @@ #ifdef __cplusplus } #endif @interface OFDataArray (MessagePackValue) +/*! + * @brief Parses the MessagePack representation and returns it as an object. + * + * @return The MessagePack representation as an object + */ - (id)messagePackValue; @end Index: src/OFDataArray.h ================================================================== --- src/OFDataArray.h +++ src/OFDataArray.h @@ -20,10 +20,12 @@ @class OFString; @class OFURL; /*! + * @class OFDataArray OFDataArray.h ObjFW/OFDataArray.h + * * @brief A class for storing arbitrary data in an array. * * If you plan to store large hunks of data, you should consider using * OFBigDataArray, which allocates the memory in pages rather than in bytes. * Index: src/OFDate.h ================================================================== --- src/OFDate.h +++ src/OFDate.h @@ -19,10 +19,12 @@ @class OFString; @class OFConstantString; /*! + * @class OFDate OFDate.h ObjFW/OFDate.h + * * @brief A class for storing, accessing and comparing dates. */ @interface OFDate: OFObject { of_time_interval_t _seconds; Index: src/OFDeflate64Stream.h ================================================================== --- src/OFDeflate64Stream.h +++ src/OFDeflate64Stream.h @@ -15,10 +15,12 @@ */ #import "OFDeflateStream.h" /*! + * @class OFDeflate64Stream OFDeflate64Stream.h ObjFW/OFDeflate64Stream.h + * * @brief A class for a stream that handles Deflate64 compression or * decompression transparently for an underlying stream. */ @interface OFDeflate64Stream: OFDeflateStream @end Index: src/OFDeflateStream.h ================================================================== --- src/OFDeflateStream.h +++ src/OFDeflateStream.h @@ -17,10 +17,12 @@ #import "OFStream.h" #define OF_DEFLATE_STREAM_BUFFER_SIZE 4096 /*! + * @class OFDeflateStream OFDeflateStream.h ObjFW/OFDeflateStream.h + * * @brief A class for a stream that handles Deflate compression or decompression * transparently for an underlying stream. */ @interface OFDeflateStream: OFStream { Index: src/OFDictionary.h ================================================================== --- src/OFDictionary.h +++ src/OFDictionary.h @@ -38,16 +38,18 @@ typedef bool (^of_dictionary_filter_block_t)(id key, id object); typedef id (^of_dictionary_map_block_t)(id key, id object); #endif /*! + * @class OFDictionary OFDictionary.h ObjFW/OFDictionary.h + * * @brief An abstract class for storing objects in a dictionary. * * Keys are copied and thus must conform to the OFCopying protocol. * - * Note: Fast enumeration on a dictionary enumerates through the keys of the - * dictionary. + * @note Fast enumeration on a dictionary enumerates through the keys of the + * dictionary. */ @interface OFDictionary: OFObject /*! * @brief Creates a new OFDictionary. Index: src/OFEnumerator.h ================================================================== --- src/OFEnumerator.h +++ src/OFEnumerator.h @@ -18,10 +18,12 @@ @class OFEnumerator; @class OFArray; /*! + * @protocol OFEnumerating OFEnumerator.h ObjFW/OFEnumerator.h + * * @brief A protocol for getting an enumerator for the object. */ @protocol OFEnumerating /*! * @brief Returns an OFEnumerator to enumerate through all objects of the @@ -31,10 +33,12 @@ */ - (OFEnumerator*)objectEnumerator; @end /*! + * @class OFEnumerator OFEnumerator.h ObjFW/OFEnumerator.h + * * @brief A class which provides methods to enumerate through collections. */ @interface OFEnumerator: OFObject /*! * @brief Returns the next object. @@ -64,13 +68,15 @@ * this as well. */ #define of_fast_enumeration_state_t NSFastEnumerationState #ifndef NSINTEGER_DEFINED /*! + * @struct of_fast_enumeration_state_t OFEnumerator.h ObjFW/OFEnumerator.h + * * @brief State information for fast enumerations. */ -typedef struct of_fast_enumeration_state_t { +typedef struct { /// Arbitrary state information for the enumeration unsigned long state; /// Pointer to a C array of objects to return __unsafe_unretained id *itemsPtr; /// Arbitrary state information to detect mutations @@ -79,10 +85,12 @@ unsigned long extra[5]; } of_fast_enumeration_state_t; #endif /*! + * @protocol OFFastEnumeration OFEnumerator.h ObjFW/OFEnumerator.h + * * @brief A protocol for fast enumeration. * * The OFFastEnumeration protocol needs to be implemented by all classes * supporting fast enumeration. */ Index: src/OFFile.h ================================================================== --- src/OFFile.h +++ src/OFFile.h @@ -34,10 +34,12 @@ #else typedef struct _stat of_stat_t; #endif /*! + * @class OFFile OFFile.h ObjFW/OFFile.h + * * @brief A class which provides functions to read, write and manipulate files. */ @interface OFFile: OFSeekableStream { int _fd; Index: src/OFHTTPClient.h ================================================================== --- src/OFHTTPClient.h +++ src/OFHTTPClient.h @@ -27,10 +27,12 @@ @class OFTCPSocket; @class OFDictionary; @class OFDataArray; /*! + * @protocol OFHTTPClientDelegate OFHTTPClient.h ObjFW/OFHTTPClient.h + * * @brief A delegate for OFHTTPClient. */ @protocol OFHTTPClientDelegate #ifdef OF_HAVE_OPTIONAL_PROTOCOLS @optional @@ -89,10 +91,12 @@ statusCode: (int)statusCode request: (OFHTTPRequest*)request; @end /*! + * @class OFHTTPClient OFHTTPClient.h ObjFW/OFHTTPClient.h + * * @brief A class for performing HTTP requests. */ @interface OFHTTPClient: OFObject { id _delegate; Index: src/OFHTTPRequest.h ================================================================== --- src/OFHTTPRequest.h +++ src/OFHTTPRequest.h @@ -28,11 +28,11 @@ /*! @file */ /*! * @brief The type of an HTTP request. */ -typedef enum of_http_request_method_t { +typedef enum { /*! OPTIONS */ OF_HTTP_REQUEST_METHOD_OPTIONS, /*! GET */ OF_HTTP_REQUEST_METHOD_GET, /*! HEAD */ @@ -48,20 +48,25 @@ /*! CONNECT */ OF_HTTP_REQUEST_METHOD_CONNECT } of_http_request_method_t; /*! + * @struct of_http_request_protocol_version_t \ + * OFHTTPRequest.h ObjFW/OFHTTPRequest.h + * * @brief The HTTP version of the HTTP request. */ -typedef struct of_http_request_protocol_version_t { +typedef struct { /*! The major of the HTTP version */ uint8_t major; /*! The minor of the HTTP version */ uint8_t minor; } of_http_request_protocol_version_t; /*! + * @class OFHTTPRequest OFHTTPRequest.h ObjFW/OFHTTPRequest.h + * * @brief A class for storing HTTP requests. */ @interface OFHTTPRequest: OFObject { OFURL *_URL; Index: src/OFHTTPResponse.h ================================================================== --- src/OFHTTPResponse.h +++ src/OFHTTPResponse.h @@ -18,10 +18,12 @@ #import "OFHTTPRequest.h" @class OFDictionary; /*! + * @class OFHTTPResponse OFHTTPResponse.h ObjFW/OFHTTPResponse.h + * * @brief A class for representing an HTTP request reply as a stream. */ @interface OFHTTPResponse: OFStream { of_http_request_protocol_version_t _protocolVersion; Index: src/OFHTTPServer.h ================================================================== --- src/OFHTTPServer.h +++ src/OFHTTPServer.h @@ -25,10 +25,12 @@ @class OFHTTPResponse; @class OFTCPSocket; @class OFException; /*! + * @protocol OFHTTPServerDelegate OFHTTPServer.h ObjFW/OFHTTPServer.h + * * @brief A delegate for OFHTTPServer. */ @protocol OFHTTPServerDelegate /*! * @brief This method is called when the HTTP server received a request from a @@ -59,10 +61,12 @@ - (bool)server: (OFHTTPServer*)server didReceiveExceptionOnListeningSocket: (OFException*)exception; @end /*! + * @class OFHTTPServer OFHTTPServer.h ObjFW/OFHTTPServer.h + * * @brief A class for creating a simple HTTP server inside of applications. */ @interface OFHTTPServer: OFObject { OFString *_host; Index: src/OFHash.h ================================================================== --- src/OFHash.h +++ src/OFHash.h @@ -15,10 +15,12 @@ */ #import "OFObject.h" /*! + * @protocol OFHash OFHash.h ObjFW/OFHash.h + * * @brief A protocol for classes providing hash functions. */ @protocol OFHash #ifdef OF_HAVE_PROPERTIES @property (readonly, getter=isCalculated) bool calculated; Index: src/OFINICategory.h ================================================================== --- src/OFINICategory.h +++ src/OFINICategory.h @@ -18,10 +18,12 @@ @class OFString; @class OFMutableArray; /*! + * @class OFINICategory OFINICategory.h ObjFW/OFINICategory.h + * * @brief A class for representing a category of an INI file. */ @interface OFINICategory: OFObject { OFString *_name; Index: src/OFINIFile.h ================================================================== --- src/OFINIFile.h +++ src/OFINIFile.h @@ -19,10 +19,12 @@ @class OFMutableArray; @class OFString; @class OFINICategory; /*! + * @class OFINIFile OFINIFile.h ObjFW/OFINIFile.h + * * @brief A class for reading, creating and modifying INI files. */ @interface OFINIFile: OFObject { OFMutableArray *_categories; Index: src/OFIntrospection.h ================================================================== --- src/OFIntrospection.h +++ src/OFIntrospection.h @@ -32,10 +32,12 @@ OF_PROPERTY_ATOMIC = 0x400, OF_PROPERTY_WEAK = 0x800 }; /*! + * @class OFMethod OFIntrospection.h ObjFW/OFIntrospection.h + * * @brief A class for describing a method. */ @interface OFMethod: OFObject { SEL _selector; @@ -70,10 +72,12 @@ */ - (const char*)typeEncoding; @end /*! + * @class OFProperty OFIntrospection.h ObjFW/OFIntrospection.h + * * @brief A class for describing a property. */ @interface OFProperty: OFObject { OFString *_name; @@ -129,10 +133,12 @@ */ - (OFString*)setter; @end /*! + * @class OFInstanceVariable OFIntrospection.h ObjFW/OFIntrospection.h + * * @brief A class for describing an instance variable. */ @interface OFInstanceVariable: OFObject { OFString *_name; @@ -167,10 +173,12 @@ */ - (const char*)typeEncoding; @end /*! + * @class OFIntrospection OFIntrospection.h ObjFW/OFIntrospection.h + * * @brief A class for introspecting classes. */ @interface OFIntrospection: OFObject { OFMutableArray *_classMethods; Index: src/OFJSONRepresentation.h ================================================================== --- src/OFJSONRepresentation.h +++ src/OFJSONRepresentation.h @@ -21,10 +21,13 @@ OF_JSON_REPRESENTATION_JSON5 = 0x02, OF_JSON_REPRESENTATION_IDENTIFIER = 0x10 }; /*! + * @protocol OFJSONRepresentation + * OFJSONRepresentation.h ObjFW/OFJSONRepresentation.h + * * @brief A protocol implemented by classes that support encoding to a JSON * representation. * * @warning Although this method can be called directly on classes other than * OFArray and OFDictionary, this will generate invalid JSON, as JSON Index: src/OFKernelEventObserver.h ================================================================== --- src/OFKernelEventObserver.h +++ src/OFKernelEventObserver.h @@ -25,10 +25,13 @@ @class OFMutex; #endif @class OFDate; /*! + * @protocol OFKernelEventObserverDelegate + * OFKernelEventObserver.h ObjFW/OFKernelEventObserver.h + * * @brief A protocol that needs to be implemented by delegates for * OFKernelEventObserver. */ @protocol OFKernelEventObserverDelegate #ifdef OF_HAVE_OPTIONAL_PROTOCOLS @@ -57,10 +60,13 @@ */ - (void)objectIsReadyForWriting: (id)object; @end /*! + * @protocol OFReadyForReadingObserving + * OFKernelEventObserver.h ObjFW/OFKernelEventObserver.h + * * @brief This protocol is implemented by classes which can be observed for * readiness for reading by OFKernelEventObserver. */ @protocol OFReadyForReadingObserving /*! @@ -72,10 +78,13 @@ */ - (int)fileDescriptorForReading; @end /*! + * @protocol OFReadyForWritingObserving + * OFKernelEventObserver.h ObjFW/OFKernelEventObserver.h + * * @brief This protocol is implemented by classes which can be observed for * readiness for writing by OFKernelEventObserver. */ @protocol OFReadyForWritingObserving /*! @@ -87,10 +96,13 @@ */ - (int)fileDescriptorForWriting; @end /*! + * @class OFKernelEventObserver + * OFKernelEventObserver.h ObjFW/OFKernelEventObserver.h + * * @brief A class that can observe multiple kernel events (e.g. streams being * ready to read) at once. * * @note Currently, Win32 can only observe TCP and UDP sockets! */ Index: src/OFList.h ================================================================== --- src/OFList.h +++ src/OFList.h @@ -19,10 +19,12 @@ #import "OFEnumerator.h" #import "OFSerialization.h" typedef struct of_list_object_t of_list_object_t; /*! + * @struct of_list_object_t OFList.h ObjFW/OFList.h + * * @brief A list object. * * A struct that contains a pointer to the next list object, the previous list * object and the object. */ @@ -34,10 +36,12 @@ /// The object for the list object __unsafe_unretained id object; }; /*! + * @class OFList OFList.h ObjFW/OFList.h + * * @brief A class which provides easy to use double-linked lists. */ @interface OFList: OFObject { of_list_object_t *_firstListObject; Index: src/OFLocking.h ================================================================== --- src/OFLocking.h +++ src/OFLocking.h @@ -15,10 +15,12 @@ */ #import "OFObject.h" /*! + * @protocol OFLocking OFLocking.h ObjFW/OFLocking.h + * * @brief A protocol for locks. */ @protocol OFLocking #ifdef OF_HAVE_PROPERTIES @property (copy) OFString *name; Index: src/OFMD5Hash.h ================================================================== --- src/OFMD5Hash.h +++ src/OFMD5Hash.h @@ -15,10 +15,12 @@ */ #import "OFHash.h" /*! + * @class OFMD5Hash OFMD5Hash.h ObjFW/OFMD5Hash.h + * * @brief A class which provides functions to create an MD5 hash. */ @interface OFMD5Hash: OFObject { uint32_t _buffer[4]; Index: src/OFMapTable.h ================================================================== --- src/OFMapTable.h +++ src/OFMapTable.h @@ -18,13 +18,15 @@ #import "OFEnumerator.h" /*! @file */ /*! + * @struct of_map_table_functions_t OFMapTable.h ObjFW/OFMapTable.h + * * @brief A struct describing the functions to be used by the map table. */ -typedef struct of_map_table_functions_t { +typedef struct { /// The function to retain keys / values void* (*retain)(void *value); /// The function to release keys / values void (*release)(void *value); /// The function to hash keys @@ -56,10 +58,12 @@ #endif @class OFMapTableEnumerator; /*! + * @class OFMapTable OFMapTable.h ObjFW/OFMapTable.h + * * @brief A class similar to OFDictionary, but providing more options how keys * and values should be retained, released, compared and hashed. */ @interface OFMapTable: OFObject { @@ -223,10 +227,12 @@ */ - (of_map_table_functions_t)valueFunctions; @end /*! + * @class OFMapTableEnumerator OFMapTable.h ObjFW/OFMapTable.h + * * @brief A class which provides methods to enumerate through an OFMapTable's * keys or values. */ @interface OFMapTableEnumerator: OFObject { Index: src/OFMessagePackExtension.h ================================================================== --- src/OFMessagePackExtension.h +++ src/OFMessagePackExtension.h @@ -18,10 +18,13 @@ #import "OFMessagePackRepresentation.h" @class OFDataArray; /*! + * @class OFMessagePackExtension \ + * OFMessagePackExtension.h ObjFW/OFMessagePackExtension.h + * * @brief A class for representing the MessagePack extension type. */ @interface OFMessagePackExtension: OFObject { Index: src/OFMessagePackRepresentation.h ================================================================== --- src/OFMessagePackRepresentation.h +++ src/OFMessagePackRepresentation.h @@ -15,10 +15,13 @@ */ @class OFDataArray; /*! + * @protocol OFMessagePackRepresentation + * OFMessagePackRepresentation.h ObjFW/OFMessagePackRepresentation.h + * * @brief A protocol implemented by classes that support encoding to a * MessagePack representation. */ @protocol OFMessagePackRepresentation /*! Index: src/OFMutableArray.h ================================================================== --- src/OFMutableArray.h +++ src/OFMutableArray.h @@ -28,10 +28,12 @@ */ typedef id (^of_array_replace_block_t)(id object, size_t index); #endif /*! + * @class OFMutableArray OFArray.h ObjFW/OFArray.h + * * @brief An abstract class for storing, adding and removing objects in an * array. */ @interface OFMutableArray: OFArray /*! Index: src/OFMutableDictionary.h ================================================================== --- src/OFMutableDictionary.h +++ src/OFMutableDictionary.h @@ -28,10 +28,12 @@ */ typedef id (^of_dictionary_replace_block_t)(id key, id object); #endif /*! + * @class OFMutableDictionary OFDictionary.h ObjFW/OFDictionary.h + * * @brief An abstract class for storing and changing objects in a dictionary. */ @interface OFMutableDictionary: OFDictionary /*! * @brief Creates a new OFMutableDictionary with enough memory to hold the Index: src/OFMutableSet.h ================================================================== --- src/OFMutableSet.h +++ src/OFMutableSet.h @@ -15,10 +15,12 @@ */ #import "OFSet.h" /*! + * @class OFMutableSet OFSet.h ObjFW/OFSet.h + * * @brief An abstract class for a mutable unordered set of unique objects. */ @interface OFMutableSet: OFSet /*! * @brief Adds the specified object to the set. Index: src/OFMutableString.h ================================================================== --- src/OFMutableString.h +++ src/OFMutableString.h @@ -15,10 +15,12 @@ */ #import "OFString.h" /*! + * @class OFMutableString OFString.h ObjFW/OFString.h + * * @brief A class for storing and modifying strings. */ @interface OFMutableString: OFString /*! * @brief Sets the character at the specified index. Index: src/OFMutex.h ================================================================== --- src/OFMutex.h +++ src/OFMutex.h @@ -18,10 +18,12 @@ #import "OFLocking.h" #import "threading.h" /*! + * @class OFMutex OFMutex.h ObjFW/OFMutex.h + * * @brief A class for creating mutual exclusions. */ @interface OFMutex: OFObject { of_mutex_t _mutex; Index: src/OFNull.h ================================================================== --- src/OFNull.h +++ src/OFNull.h @@ -18,10 +18,12 @@ #import "OFSerialization.h" #import "OFJSONRepresentation.h" #import "OFMessagePackRepresentation.h" /*! + * @class OFNull OFNull.h ObjFW/OFNull.h + * * @brief A class for representing null values in collections. */ @interface OFNull: OFObject /*! Index: src/OFNumber.h ================================================================== --- src/OFNumber.h +++ src/OFNumber.h @@ -31,11 +31,11 @@ /*! @file */ /*! * @brief The C type of a number stored in an OFNumber. */ -typedef enum of_number_type_t { +typedef enum { /*! bool */ OF_NUMBER_BOOL = 0x01, /*! unsigned char */ OF_NUMBER_UCHAR = 0x02, /*! unsigned short */ @@ -92,10 +92,12 @@ /*! double */ OF_NUMBER_DOUBLE = 0x40 | OF_NUMBER_FLOAT, } of_number_type_t; /*! + * @class OFNumber OFNumber.h ObjFW/OFNumber.h + * * @brief Provides a way to store a number in an object. */ @interface OFNumber: OFObject { Index: src/OFObject+Serialization.h ================================================================== --- src/OFObject+Serialization.h +++ src/OFObject+Serialization.h @@ -24,16 +24,13 @@ extern int _OFObject_Serialization_reference; #ifdef __cplusplus } #endif -/*! - * @brief A category that provides methods for serializing objects. - */ @interface OFObject (OFSerialization) /*! * @brief Creates a string by serializing the receiver. * * @return The object serialized as a string */ - (OFString*)stringBySerializing; @end Index: src/OFObject.h ================================================================== --- src/OFObject.h +++ src/OFObject.h @@ -161,11 +161,11 @@ #define OF_NOT_FOUND SIZE_MAX /*! * @brief A result of a comparison. */ -typedef enum of_comparison_result_t { +typedef enum { /*! The left object is smaller than the right */ OF_ORDERED_ASCENDING = -1, /*! Both objects are equal */ OF_ORDERED_SAME = 0, /*! The left object is bigger than the right */ @@ -173,21 +173,23 @@ } of_comparison_result_t; /*! * @brief An enum for storing endianess. */ -typedef enum of_byte_order_t { +typedef enum { /*! Most significant byte first (big endian) */ OF_BYTE_ORDER_BIG_ENDIAN, /*! Least significant byte first (little endian) */ OF_BYTE_ORDER_LITTLE_ENDIAN } of_byte_order_t; /*! + * @struct of_range_t OFObject.h ObjFW/OFObject.h + * * @brief A range. */ -typedef struct of_range_t { +typedef struct { /*! The start of the range */ size_t location; /*! The length of the range */ size_t length; } of_range_t; @@ -196,34 +198,39 @@ * @brief A time interval in seconds. */ typedef double of_time_interval_t; /*! + * @struct of_point_t OFObject.h ObjFW/OFObject.h + * * @brief A point. */ -typedef struct of_point_t { +typedef struct { /*! The x coordinate of the point */ float x; /*! The y coordinate of the point */ float y; } of_point_t; /*! + * @struct of_dimension_t OFObject.h ObjFW/OFObject.h + * * @brief A dimension. */ -typedef struct of_dimension_t { +typedef struct { /*! The width of the dimension */ float width; /*! The height of the dimension */ float height; } of_dimension_t; /*! + * @struct of_rectangle_t OFObject.h ObjFW/OFObject.h + * * @brief A rectangle. */ -typedef struct of_rectangle_t -{ +typedef struct { /*! The point from where the rectangle originates */ of_point_t origin; /*! The size of the rectangle */ of_dimension_t size; } of_rectangle_t; @@ -230,10 +237,12 @@ @class OFString; @class OFThread; /*! + * @protocol OFObject OFObject.h ObjFW/OFObject.h + * * @brief The protocol which all root classes implement. */ @protocol OFObject /*! * @brief Returns the class of the object. @@ -405,10 +414,12 @@ */ - (bool)isProxy; @end /*! + * @class OFObject OFObject.h ObjFW/OFObject.h + * * @brief The root class for all other classes inside ObjFW. */ OF_ROOT_CLASS @interface OFObject { @@ -921,10 +932,12 @@ */ - (void)doesNotRecognizeSelector: (SEL)selector; @end /*! + * @protocol OFCopying OFObject.h ObjFW/OFObject.h + * * @brief A protocol for the creation of copies. */ @protocol OFCopying /*! * @brief Copies the object. @@ -937,10 +950,12 @@ */ - copy; @end /*! + * @protocol OFMutableCopying OFObject.h ObjFW/OFObject.h + * * @brief A protocol for the creation of mutable copies. * * This protocol is implemented by objects that can be mutable and immutable * and allows returning a mutable copy. */ @@ -952,10 +967,12 @@ */ - mutableCopy; @end /*! + * @protocol OFComparing OFObject.h ObjFW/OFObject.h + * * @brief A protocol for comparing objects. * * This protocol is implemented by objects that can be compared. */ @protocol OFComparing Index: src/OFOptionsParser.h ================================================================== --- src/OFOptionsParser.h +++ src/OFOptionsParser.h @@ -16,10 +16,12 @@ #import "OFObject.h" #import "OFConstantString.h" /*! + * @class OFOptionsParser OFOptionsParser.h ObjFW/OFOptionsParser.h + * * @brief A class for parsing the program options specified on the command line. */ @interface OFOptionsParser: OFObject { of_unichar_t *_options; Index: src/OFPlugin.h ================================================================== --- src/OFPlugin.h +++ src/OFPlugin.h @@ -24,10 +24,12 @@ # include typedef HMODULE of_plugin_handle_t; #endif /*! + * @class OFPlugin OFPlugin.h ObjFW/OFPlugin.h + * * @brief Provides a system for loading plugins at runtime. */ @interface OFPlugin: OFObject { of_plugin_handle_t _handle; Index: src/OFProcess.h ================================================================== --- src/OFProcess.h +++ src/OFProcess.h @@ -32,10 +32,12 @@ @class OFArray; @class OFDictionary; /*! + * @class OFProcess OFProcess.h ObjFW/OFProcess.h + * * @brief A class for stream-like communication with a newly created process. */ @interface OFProcess: OFStream { #ifndef _WIN32 Index: src/OFRecursiveMutex.h ================================================================== --- src/OFRecursiveMutex.h +++ src/OFRecursiveMutex.h @@ -18,10 +18,12 @@ #import "OFLocking.h" #import "threading.h" /*! + * @class OFRecursiveMutex OFRecursiveMutex.h ObjFW/OFRecursiveMutex.h + * * @brief A class for creating mutual exclusions which can be entered * recursively. */ @interface OFRecursiveMutex: OFObject { Index: src/OFRunLoop.h ================================================================== --- src/OFRunLoop.h +++ src/OFRunLoop.h @@ -29,10 +29,12 @@ #endif @class OFMutableDictionary; @class OFTimer; /*! + * @class OFRunLoop OFRunLoop.h ObjFW/OFRunLoop.h + * * @brief A class providing a run loop for the application and its processes. */ @interface OFRunLoop: OFObject { OFSortedList *_timersQueue; Index: src/OFSHA1Hash.h ================================================================== --- src/OFSHA1Hash.h +++ src/OFSHA1Hash.h @@ -15,10 +15,12 @@ */ #import "OFHash.h" /*! + * @class OFSHA1Hash OFSHA1Hash.h ObjFW/OFSHA1Hash.h + * * @brief A class which provides functions to create an SHA1 hash. */ @interface OFSHA1Hash: OFObject { uint32_t _state[5]; Index: src/OFSeekableStream.h ================================================================== --- src/OFSeekableStream.h +++ src/OFSeekableStream.h @@ -24,10 +24,12 @@ #include #import "OFStream.h" /*! + * @class OFSeekableStream OFSeekableStream.h ObjFW/OFSeekableStream.h + * * @brief A stream that supports seeking. * * @note If you want to subclass this, override * @ref lowlevelSeekToOffset:whence:. OFSeekableStream uses this method * and makes it work together with the caching of OFStream. If you Index: src/OFSerialization.h ================================================================== --- src/OFSerialization.h +++ src/OFSerialization.h @@ -19,10 +19,12 @@ #define OF_SERIALIZATION_NS @"https://webkeks.org/objfw/serialization" @class OFXMLElement; /*! + * @protocol OFSerialization OFSerialization.h ObjFW/OFSerialization.h + * * @brief A protocol for serializing objects. */ @protocol OFSerialization /*! * @brief Initializes the object with the specified XML element serialization. Index: src/OFSet.h ================================================================== --- src/OFSet.h +++ src/OFSet.h @@ -49,10 +49,12 @@ */ typedef bool (^of_set_filter_block_t)(id object); #endif /*! + * @class OFSet OFSet.h ObjFW/OFSet.h + * * @brief An abstract class for an unordered set of unique objects. * * @warning Do not mutate objects that are in a set! Changing the hash of * objects in a set breaks the internal representation of the set! */ Index: src/OFSortedList.h ================================================================== --- src/OFSortedList.h +++ src/OFSortedList.h @@ -15,10 +15,12 @@ */ #import "OFList.h" /*! + * @class OFSortedList OFSortedList.h ObjFW/OFSortedList.h + * * @brief A class which provides easy to use sorted double-linked lists. * * @warning Because the list is sorted, all methods inserting an object at a * specific place are unavailable, even though they exist in OFList! */ Index: src/OFStdIOStream.h ================================================================== --- src/OFStdIOStream.h +++ src/OFStdIOStream.h @@ -15,10 +15,12 @@ */ #import "OFStream.h" /*! + * @class OFStdIOStream OFStdIOStream.h ObjFW/OFStdIOStream.h + * * @brief A class for providing standard input, output and error as OFStream. * * The global variables @ref of_stdin, @ref of_stdout and @ref of_stderr are * instances of this class and need no initialization. */ Index: src/OFStream.h ================================================================== --- src/OFStream.h +++ src/OFStream.h @@ -59,10 +59,12 @@ typedef bool (^of_stream_async_read_line_block_t)(OFStream *stream, OFString *line, OFException *exception); #endif /*! + * @class OFStream OFStream.h ObjFW/OFStream.h + * * @brief A base class for different types of streams. * * @warning Even though the OFCopying protocol is implemented, it does *not* * return an independent copy of the stream, but instead retains it. * This is so that the stream can be used as a key for a dictionary, Index: src/OFStreamSocket.h ================================================================== --- src/OFStreamSocket.h +++ src/OFStreamSocket.h @@ -17,10 +17,12 @@ #import "OFStream.h" #import "socket.h" /*! + * @class OFStreamSocket OFStreamSocket.h ObjFW/OFStreamSocket.h + * * @brief A class which provides functions to create and use stream sockets. */ @interface OFStreamSocket: OFStream { #ifndef _WIN32 Index: src/OFString+Hashing.h ================================================================== --- src/OFString+Hashing.h +++ src/OFString+Hashing.h @@ -22,14 +22,10 @@ extern int _OFString_Hashing_reference; #ifdef __cplusplus } #endif -/*! - * @brief The OFString (Hashing) category provides methods to calculate hashes - * for strings. - */ @interface OFString (Hashing) /*! * @brief Returns the MD5 hash of the string as an autoreleased OFString. * * @return The MD5 hash of the string as an autoreleased OFString Index: src/OFString+Serialization.h ================================================================== --- src/OFString+Serialization.h +++ src/OFString+Serialization.h @@ -22,16 +22,13 @@ extern int _OFString_Serialization_reference; #ifdef __cplusplus } #endif -/*! - * @brief A category that provides methods for deserializing objects. - */ -@interface OFString (OFSerialization) +@interface OFString (Serialization) /*! * @brief Deserializes the receiver into an object. * * @return The deserialized object */ - (id)objectByDeserializing; @end Index: src/OFString+URLEncoding.h ================================================================== --- src/OFString+URLEncoding.h +++ src/OFString+URLEncoding.h @@ -22,13 +22,10 @@ extern int _OFString_URLEncoding_reference; #ifdef __cplusplus } #endif -/*! - * @brief A category which provides URL encoding and decoding. - */ @interface OFString (URLEncoding) /*! * @brief Encodes a string for use in a URL. * * @return A new autoreleased string Index: src/OFString+XMLEscaping.h ================================================================== --- src/OFString+XMLEscaping.h +++ src/OFString+XMLEscaping.h @@ -22,16 +22,13 @@ extern int _OFString_XMLEscaping_reference; #ifdef __cplusplus } #endif -/*! - * @brief A category to escape strings for use in an XML document. - */ @interface OFString (XMLEscaping) /*! * @brief Escapes a string for use in an XML document. * * @return A new autoreleased string */ - (OFString*)stringByXMLEscaping; @end Index: src/OFString+XMLUnescaping.h ================================================================== --- src/OFString+XMLUnescaping.h +++ src/OFString+XMLUnescaping.h @@ -38,10 +38,12 @@ typedef OFString* (^of_string_xml_unescaping_block_t)(OFString *string, OFString *entity); #endif /*! + * @protocol OFStringXMLUnescapingDelegate OFString.h ObjFW/OFString.h + * * @brief A protocol that needs to be implemented by delegates for * stringByXMLUnescapingWithHandler:. */ @protocol OFStringXMLUnescapingDelegate /*! @@ -58,13 +60,10 @@ */ - (OFString*)string: (OFString*)string containsUnknownEntityNamed: (OFString*)entity; @end -/*! - * @brief A category for unescaping XML in strings. - */ @interface OFString (XMLUnescaping) /*! * @brief Unescapes XML in the string. */ - (OFString*)stringByXMLUnescaping; Index: src/OFString.h ================================================================== --- src/OFString.h +++ src/OFString.h @@ -80,10 +80,12 @@ @class OFArray; @class OFURL; /*! + * @class OFString OFString.h ObjFW/OFString.h + * * @brief A class for handling strings. */ @interface OFString: OFObject #ifdef OF_HAVE_PROPERTIES Index: src/OFSystemInfo.h ================================================================== --- src/OFSystemInfo.h +++ src/OFSystemInfo.h @@ -15,10 +15,12 @@ */ #import "OFObject.h" /*! + * @class OFSystemInfo OFSystemInfo.h ObjFW/OFSystemInfo.h + * * @brief A class for querying information about the system. */ @interface OFSystemInfo: OFObject /*! * @brief Returns the size of a page. Index: src/OFTCPSocket.h ================================================================== --- src/OFTCPSocket.h +++ src/OFTCPSocket.h @@ -47,10 +47,12 @@ typedef bool (^of_tcp_socket_async_accept_block_t)(OFTCPSocket *socket, OFTCPSocket *acceptedSocket, OFException *exception); #endif /*! + * @class OFTCPSocket OFTCPSocket.h ObjFW/OFTCPSocket.h + * * @brief A class which provides functions to create and use TCP sockets. * * To connect to a server, create a socket and connect it. * To create a server, create a socket, bind it and listen on it. */ Index: src/OFTLSSocket.h ================================================================== --- src/OFTLSSocket.h +++ src/OFTLSSocket.h @@ -19,10 +19,12 @@ @class OFString; @class OFArray; @protocol OFTLSSocket; /*! + * @protocol OFTLSSocketDelegate OFTLSSocket.h ObjFW/OFTLSSocket.h + * * @brief A delegate for classes implementing the OFTLSSocket protocol. */ @protocol OFTLSSocketDelegate /*! * @brief This callback is called when the TLS socket wants to know if it @@ -37,10 +39,12 @@ - (bool)socket: (id )socket shouldAcceptKeychain: (OFArray*)keychain; @end /*! + * @protocol OFTLSSocket OFTLSSocket.h ObjFW/OFTLSSocket.h + * * @brief A protocol that should be implemented by 3rd-party libraries * implementing TLS. */ @protocol OFTLSSocket #ifdef OF_HAVE_PROPERTIES Index: src/OFThread.h ================================================================== --- src/OFThread.h +++ src/OFThread.h @@ -34,10 +34,12 @@ */ typedef id (^of_thread_block_t)(void); #endif /*! + * @class OFThread OFThread.h ObjFW/OFThread.h + * * @brief A class which provides portable threads. * * To use it, you should create a new class derived from it and reimplement * main. * Index: src/OFThreadPool.h ================================================================== --- src/OFThreadPool.h +++ src/OFThreadPool.h @@ -29,10 +29,12 @@ @class OFList; @class OFCondition; @class OFThreadPoolJob; /*! + * @class OFThreadPool OFThreadPool.h ObjFW/OFThreadPool.h + * * @brief A class providing a pool of reusable threads. * * @note When the thread pool is released, all threads will terminate after * they finish the job they are currently processing. */ Index: src/OFTimer.h ================================================================== --- src/OFTimer.h +++ src/OFTimer.h @@ -33,10 +33,12 @@ */ typedef void (^of_timer_block_t)(OFTimer *timer); #endif /*! + * @class OFTimer OFTimer.h ObjFW/OFTimer.h + * * @brief A class for creating and firing timers. */ @interface OFTimer: OFObject { OFDate *_fireDate; Index: src/OFUDPSocket.h ================================================================== --- src/OFUDPSocket.h +++ src/OFUDPSocket.h @@ -23,10 +23,12 @@ @class OFUDPSocket; @class OFException; /*! + * @struct of_udp_socket_address_t OFUDPSocket.h ObjFW/OFUDPSocket.h + * * @brief A struct which represents a host / port pair for a UDP socket. */ typedef struct { struct sockaddr_storage address; socklen_t length; @@ -61,10 +63,12 @@ void *buffer, size_t length, of_udp_socket_address_t sender, OFException *exception); #endif /*! + * @class OFUDPSocket OFUDPSocket.h ObjFW/OFUDPSocket.h + * * @brief A class which provides functions to create and use UDP sockets. * * Addresses are of type @ref of_udp_socket_address_t. You can use @ref * getHost:andPort:forAddress: to create an address for a host / port pair and * @ref getHost:andPort:forAddress: to get the host / port pair for an address. Index: src/OFURL.h ================================================================== --- src/OFURL.h +++ src/OFURL.h @@ -18,10 +18,12 @@ #import "OFSerialization.h" @class OFString; /*! + * @class OFURL OFURL.h ObjFW/OFURL.h + * * @brief A class for parsing URLs and accessing parts of it. */ @interface OFURL: OFObject { OFString *_scheme, *_host; Index: src/OFXMLAttribute.h ================================================================== --- src/OFXMLAttribute.h +++ src/OFXMLAttribute.h @@ -17,10 +17,12 @@ #import "OFXMLNode.h" @class OFString; /*! + * @class OFXMLAttribute OFXMLAttribute.h ObjFW/OFXMLAttribute.h + * * @brief A representation of an attribute of an XML element as an object. */ @interface OFXMLAttribute: OFXMLNode { @public Index: src/OFXMLCDATA.h ================================================================== --- src/OFXMLCDATA.h +++ src/OFXMLCDATA.h @@ -15,10 +15,12 @@ */ #import "OFXMLNode.h" /*! + * @class OFXMLCDATA OFXMLCDATA.h ObjFW/OFXMLCDATA.h + * * @brief A class representing XML CDATA. */ @interface OFXMLCDATA: OFXMLNode { OFString *_CDATA; Index: src/OFXMLCharacters.h ================================================================== --- src/OFXMLCharacters.h +++ src/OFXMLCharacters.h @@ -15,10 +15,12 @@ */ #import "OFXMLNode.h" /*! + * @class OFXMLCharacters OFXMLCharacters.h ObjFW/OFXMLCharacters.h + * * @brief A class representing XML characters. */ @interface OFXMLCharacters: OFXMLNode { OFString *_characters; Index: src/OFXMLComment.h ================================================================== --- src/OFXMLComment.h +++ src/OFXMLComment.h @@ -15,10 +15,12 @@ */ #import "OFXMLNode.h" /*! + * @class OFXMLComment OFXMLComment.h ObjFW/OFXMLComment.h + * * @brief A class for representing XML comments. */ @interface OFXMLComment: OFXMLNode { OFString *_comment; Index: src/OFXMLElement+Serialization.h ================================================================== --- src/OFXMLElement+Serialization.h +++ src/OFXMLElement+Serialization.h @@ -22,16 +22,13 @@ extern int _OFXMLElement_Serialization_reference; #ifdef __cplusplus } #endif -/*! - * @brief A category that provides methods for deserializing objects. - */ @interface OFXMLElement (OFSerialization) /*! * @brief Deserializes the receiver into an object. * * @return The deserialized object */ - (id)objectByDeserializing; @end Index: src/OFXMLElement.h ================================================================== --- src/OFXMLElement.h +++ src/OFXMLElement.h @@ -22,10 +22,12 @@ @class OFMutableArray; @class OFMutableDictionary; @class OFXMLAttribute; /*! + * @class OFXMLElement OFXMLElement.h ObjFW/OFXMLElement.h + * * @brief A class which stores an XML element. */ @interface OFXMLElement: OFXMLNode { OFString *_name, *_namespace, *_defaultNamespace; Index: src/OFXMLElementBuilder.h ================================================================== --- src/OFXMLElementBuilder.h +++ src/OFXMLElementBuilder.h @@ -20,10 +20,13 @@ @class OFMutableArray; @class OFXMLElement; @class OFXMLElementBuilder; /*! + * @protocol OFXMLElementBuilderDelegate + * OFXMLElementBuilder.h ObjFW/OFXMLElementBuilder.h + * * @brief A protocol that needs to be implemented by delegates for * OFXMLElementBuilder. */ @protocol OFXMLElementBuilderDelegate /*! @@ -90,10 +93,12 @@ - (OFString*)elementBuilder: (OFXMLElementBuilder*)builder foundUnknownEntityNamed: (OFString*)entity; @end /*! + * @class OFXMLElementBuilder OFXMLElementBuilder.h ObjFW/OFXMLElementBuilder.h + * * @brief A class implementing the OFXMLParserDelegate protocol that can build * OFXMLElements from the document parsed by the OFXMLParser. * * It can also be used to build OFXMLElements from parts of the document by * first parsing stuff using the OFXMLParser with another delegate and then Index: src/OFXMLNode.h ================================================================== --- src/OFXMLNode.h +++ src/OFXMLNode.h @@ -16,10 +16,12 @@ #import "OFObject.h" #import "OFSerialization.h" /*! + * @class OFXMLNode OFXMLNode.h ObjFW/OFXMLNode.h + * * @brief A class which stores an XML element. */ @interface OFXMLNode: OFObject /*! * @brief Returns the contents of the receiver as a string value. Index: src/OFXMLParser.h ================================================================== --- src/OFXMLParser.h +++ src/OFXMLParser.h @@ -23,10 +23,12 @@ @class OFMutableArray; @class OFDataArray; @class OFStream; /*! + * @protocol OFXMLParserDelegate OFXMLParser.h ObjFW/OFXMLParser.h + * * @brief A protocol that needs to be implemented by delegates for OFXMLParser. */ @protocol OFXMLParserDelegate #ifdef OF_HAVE_OPTIONAL_PROTOCOLS @optional @@ -116,10 +118,12 @@ - (OFString*)parser: (OFXMLParser*)parser foundUnknownEntityNamed: (OFString*)entity; @end /*! + * @class OFXMLParser OFXMLParser.h ObjFW/OFXMLParser.h + * * @brief An event-based XML parser. * * OFXMLParser is an event-based XML parser which calls the delegate's callbacks * as soon asit finds something, thus suitable for streams as well. */ Index: src/OFXMLProcessingInstructions.h ================================================================== --- src/OFXMLProcessingInstructions.h +++ src/OFXMLProcessingInstructions.h @@ -15,10 +15,13 @@ */ #import "OFXMLNode.h" /*! + * @class OFXMLProcessingInstructions \ + * OFXMLProcessingInstructions.h ObjFW/OFXMLProcessingInstructions.h + * * @brief A class for representing XML processing instructions. */ @interface OFXMLProcessingInstructions: OFXMLNode { OFString *_processingInstructions; Index: src/OFZIPArchive.h ================================================================== --- src/OFZIPArchive.h +++ src/OFZIPArchive.h @@ -22,10 +22,12 @@ @class OFMutableArray; @class OFMutableDictionary; @class OFStream; /*! + * @class OFZIPArchive OFZIPArchive.h ObjFW/OFZIPArchive.h + * * @brief A class for accessing and manipulating ZIP files. */ @interface OFZIPArchive: OFObject { OFFile *_file; Index: src/OFZIPArchiveEntry.h ================================================================== --- src/OFZIPArchiveEntry.h +++ src/OFZIPArchiveEntry.h @@ -22,10 +22,12 @@ @class OFDataArray; @class OFFile; @class OFDate; /*! + * @class OFZIPArchiveEntry OFZIPArchiveEntry.h ObjFW/OFZIPArchiveEntry.h + * * @brief A class which represents an entry in the central directory of a ZIP * archive. */ @interface OFZIPArchiveEntry: OFObject { Index: src/bridge/NSArray+OFObject.h ================================================================== --- src/bridge/NSArray+OFObject.h +++ src/bridge/NSArray+OFObject.h @@ -17,9 +17,12 @@ #import #import "NSBridging.h" /*! + * @category NSArray (OFObject) \ + * NSArray+OFObject.h ObjFW-Bridge/NSArray+OFObject.h + * * @brief Support for bridging NSArrays to OFArrays. */ @interface NSArray (OFObject) @end Index: src/bridge/NSBridging.h ================================================================== --- src/bridge/NSBridging.h +++ src/bridge/NSBridging.h @@ -13,10 +13,12 @@ * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this * file. */ /*! + * @protocol NSBridging NSBridging.h ObjFW-Bridge/NSBridging.h + * * @brief A protocol implemented by classes supporting bridging Foundation * objects to ObjFW objects. */ @protocol NSBridging /*! Index: src/bridge/NSDictionary+OFObject.h ================================================================== --- src/bridge/NSDictionary+OFObject.h +++ src/bridge/NSDictionary+OFObject.h @@ -17,9 +17,12 @@ #import #import "NSBridging.h" /*! + * @category NSDictionary (OFObject) \ + * NSDictionary+OFObject.h ObjFW-Bridge/NSDictionary+OFObject.h + * * @brief Support for bridging NSDictionaries to OFDictionaries. */ @interface NSDictionary (OFObject) @end Index: src/bridge/NSString+OFObject.h ================================================================== --- src/bridge/NSString+OFObject.h +++ src/bridge/NSString+OFObject.h @@ -17,13 +17,16 @@ #import #import "NSBridging.h" /*! + * @category NSString (OFObject) + * NSString+OFObject.h ObjFW-Bridge/NSString+OFObject.h + * * @brief Support for bridging NSStrings to OFStrings. * * Unfortunately, they need to be copied, as NSString is not capable of * handling UCS-4 properly (a character of NSString is only 2 bytes, while a * character of OFString is 4). */ @interface NSString (OFObject) @end Index: src/bridge/OFArray+NSObject.h ================================================================== --- src/bridge/OFArray+NSObject.h +++ src/bridge/OFArray+NSObject.h @@ -21,9 +21,11 @@ #endif #import "OFBridging.h" /*! + * @category OFArray (NSObject) \ + * OFArray+NSObject.h ObjFW-Bridge/OFArray+NSObject.h * @brief Support for bridging OFArrays to NSArrays. */ @interface OFArray (NSObject) @end Index: src/bridge/OFBridging.h ================================================================== --- src/bridge/OFBridging.h +++ src/bridge/OFBridging.h @@ -13,10 +13,12 @@ * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this * file. */ /*! + * @protocol OFBridging OFBridging.h ObjFW-Bridge/OFBridging.h + * * @brief A protocol implemented by classes supporting bridging ObjFW objects * to Foundation objects. */ @protocol OFBridging /*! Index: src/bridge/OFDictionary+NSObject.h ================================================================== --- src/bridge/OFDictionary+NSObject.h +++ src/bridge/OFDictionary+NSObject.h @@ -21,9 +21,12 @@ #endif #import "OFBridging.h" /*! + * @category OFDictionary (NSObject) \ + * OFDictionary+NSObject.h ObjFW-Bridge/OFDictionary+NSObject.h + * * @brief Support for bridging OFDictionaries to NSDictionaries. */ @interface OFDictionary (NSObject) @end Index: src/bridge/OFString+NSObject.h ================================================================== --- src/bridge/OFString+NSObject.h +++ src/bridge/OFString+NSObject.h @@ -21,13 +21,16 @@ #endif #import "OFBridging.h" /*! + * @category OFString (NSObject) \ + * OFString+NSObject.h ObjFW-Bridge/OFString+NSObject.h + * * @brief Support for bridging OFStrings to NSStrings. * * Unfortunately, they need to be copied, as NSString is not capable of * handling UCS-4 properly (a character of NSString is only 2 bytes, while a * character of OFString is 4). */ @interface OFString (NSObject) @end Index: src/exceptions/OFAcceptFailedException.h ================================================================== --- src/exceptions/OFAcceptFailedException.h +++ src/exceptions/OFAcceptFailedException.h @@ -21,10 +21,13 @@ #ifndef OF_HAVE_SOCKETS # error No sockets available! #endif /*! + * @class OFAcceptFailedException \ + * OFAcceptFailedException.h ObjFW/OFAcceptFailedException.h + * * @brief An exception indicating that accepting a connection failed. */ @interface OFAcceptFailedException: OFException { id _socket; Index: src/exceptions/OFAddressTranslationFailedException.h ================================================================== --- src/exceptions/OFAddressTranslationFailedException.h +++ src/exceptions/OFAddressTranslationFailedException.h @@ -21,10 +21,14 @@ #ifndef OF_HAVE_SOCKETS # error No sockets available! #endif /*! + * @class OFAddressTranslationFailedException \ + * OFAddressTranslationFailedException.h \ + * ObjFW/OFAddressTranslationFailedException.h + * * @brief An exception indicating the translation of an address failed. */ @interface OFAddressTranslationFailedException: OFException { OFString *_host; Index: src/exceptions/OFAllocFailedException.h ================================================================== --- src/exceptions/OFAllocFailedException.h +++ src/exceptions/OFAllocFailedException.h @@ -17,10 +17,13 @@ #import "OFObject.h" @class OFString; /*! + * @class OFAllocFailedException \ + * OFAllocFailedException.h ObjFW/OFAllocFailedException.h + * * @brief An exception indicating an object could not be allocated. * * This exception is preallocated, as when there's no memory, no exception can * be allocated of course. That's why you shouldn't and even can't deallocate * it. Index: src/exceptions/OFAlreadyConnectedException.h ================================================================== --- src/exceptions/OFAlreadyConnectedException.h +++ src/exceptions/OFAlreadyConnectedException.h @@ -19,10 +19,13 @@ #ifndef OF_HAVE_SOCKETS # error No sockets available! #endif /*! + * @class OFAlreadyConnectedException \ + * OFAlreadyConnectedException.h ObjFW/OFAlreadyConnectedException.h + * * @brief An exception indicating an attempt to connect or bind an already * connected or bound socket. */ @interface OFAlreadyConnectedException: OFException { Index: src/exceptions/OFBindFailedException.h ================================================================== --- src/exceptions/OFBindFailedException.h +++ src/exceptions/OFBindFailedException.h @@ -21,10 +21,13 @@ #ifndef OF_HAVE_SOCKETS # error No sockets available! #endif /*! + * @class OFBindFailedException \ + * OFBindFailedException.h ObjFW/OFBindFailedException.h + * * @brief An exception indicating that binding a socket failed. */ @interface OFBindFailedException: OFException { id _socket; Index: src/exceptions/OFChangeCurrentDirectoryPathFailedException.h ================================================================== --- src/exceptions/OFChangeCurrentDirectoryPathFailedException.h +++ src/exceptions/OFChangeCurrentDirectoryPathFailedException.h @@ -17,10 +17,14 @@ #include #import "OFException.h" /*! + * @class OFChangeCurrentDirectoryPathFailedException \ + * OFChangeCurrentDirectoryPathFailedException.h \ + * ObjFW/OFChangeCurrentDirectoryPathFailedException.h + * * @brief An exception indicating that changing the current directory path * failed. */ @interface OFChangeCurrentDirectoryPathFailedException: OFException { Index: src/exceptions/OFChangeOwnerFailedException.h ================================================================== --- src/exceptions/OFChangeOwnerFailedException.h +++ src/exceptions/OFChangeOwnerFailedException.h @@ -18,10 +18,13 @@ #import "OFException.h" #ifdef OF_HAVE_CHOWN /*! + * @class OFChangeOwnerFailedException \ + * OFChangeOwnerFailedException.h ObjFW/OFChangeOwnerFailedException.h + * * @brief An exception indicating that changing the owner of an item failed. */ @interface OFChangeOwnerFailedException: OFException { OFString *_path, *_owner, *_group; Index: src/exceptions/OFChangePermissionsFailedException.h ================================================================== --- src/exceptions/OFChangePermissionsFailedException.h +++ src/exceptions/OFChangePermissionsFailedException.h @@ -19,10 +19,14 @@ #include #import "OFException.h" /*! + * @class OFChangePermissionsFailedException \ + * OFChangePermissionsFailedException.h \ + * ObjFW/OFChangePermissionsFailedException.h + * * @brief An exception indicating that changing the permissions of an item * failed. */ @interface OFChangePermissionsFailedException: OFException { Index: src/exceptions/OFChecksumFailedException.h ================================================================== --- src/exceptions/OFChecksumFailedException.h +++ src/exceptions/OFChecksumFailedException.h @@ -15,9 +15,12 @@ */ #import "OFException.h" /*! + * @class OFChecksumFailedException \ + * OFChecksumFailedException.h ObjFW/OFChecksumFailedException.h + * * @brief An exception indicating that a checksum did not match. */ @interface OFChecksumFailedException: OFException @end Index: src/exceptions/OFConditionBroadcastFailedException.h ================================================================== --- src/exceptions/OFConditionBroadcastFailedException.h +++ src/exceptions/OFConditionBroadcastFailedException.h @@ -21,10 +21,14 @@ #endif @class OFCondition; /*! + * @class OFConditionBroadcastFailedException \ + * OFConditionBroadcastFailedException.h \ + * ObjFW/OFConditionBroadcastFailedException.h + * * @brief An exception indicating broadcasting a condition failed. */ @interface OFConditionBroadcastFailedException: OFException { OFCondition *_condition; Index: src/exceptions/OFConditionSignalFailedException.h ================================================================== --- src/exceptions/OFConditionSignalFailedException.h +++ src/exceptions/OFConditionSignalFailedException.h @@ -21,10 +21,14 @@ #endif @class OFCondition; /*! + * @class OFConditionSignalFailedException \ + * OFConditionSignalFailedException.h \ + * ObjFW/OFConditionSignalFailedException.h + * * @brief An exception indicating signaling a condition failed. */ @interface OFConditionSignalFailedException: OFException { OFCondition *_condition; Index: src/exceptions/OFConditionStillWaitingException.h ================================================================== --- src/exceptions/OFConditionStillWaitingException.h +++ src/exceptions/OFConditionStillWaitingException.h @@ -21,10 +21,14 @@ #endif @class OFCondition; /*! + * @class OFConditionStillWaitingException \ + * OFConditionStillWaitingException.h \ + * ObjFW/OFConditionStillWaitingException.h + * * @brief An exception indicating that a thread is still waiting for a * condition. */ @interface OFConditionStillWaitingException: OFException { Index: src/exceptions/OFConditionWaitFailedException.h ================================================================== --- src/exceptions/OFConditionWaitFailedException.h +++ src/exceptions/OFConditionWaitFailedException.h @@ -21,10 +21,14 @@ #endif @class OFCondition; /*! + * @class OFConditionWaitFailedException \ + * OFConditionWaitFailedException.h \ + * ObjFW/OFConditionWaitFailedException.h + * * @brief An exception indicating waiting for a condition failed. */ @interface OFConditionWaitFailedException: OFException { OFCondition *_condition; Index: src/exceptions/OFConnectionFailedException.h ================================================================== --- src/exceptions/OFConnectionFailedException.h +++ src/exceptions/OFConnectionFailedException.h @@ -21,10 +21,13 @@ #ifndef OF_HAVE_SOCKETS # error No sockets available! #endif /*! + * @class OFConnectionFailedException \ + * OFConnectionFailedException.h ObjFW/OFConnectionFailedException.h + * * @brief An exception indicating that a connection could not be established. */ @interface OFConnectionFailedException: OFException { id _socket; Index: src/exceptions/OFCopyItemFailedException.h ================================================================== --- src/exceptions/OFCopyItemFailedException.h +++ src/exceptions/OFCopyItemFailedException.h @@ -17,10 +17,13 @@ #include #import "OFException.h" /*! + * @class OFCopyItemFailedException \ + * OFCopyItemFailedException.h ObjFW/OFCopyItemFailedException.h + * * @brief An exception indicating that copying a item failed. */ @interface OFCopyItemFailedException: OFException { OFString *_sourcePath, *_destinationPath; Index: src/exceptions/OFCreateDirectoryFailedException.h ================================================================== --- src/exceptions/OFCreateDirectoryFailedException.h +++ src/exceptions/OFCreateDirectoryFailedException.h @@ -17,10 +17,14 @@ #include #import "OFException.h" /*! + * @class OFCreateDirectoryFailedException \ + * OFCreateDirectoryFailedException.h \ + * ObjFW/OFCreateDirectoryFailedException.h + * * @brief An exception indicating a directory couldn't be created. */ @interface OFCreateDirectoryFailedException: OFException { OFString *_path; Index: src/exceptions/OFCreateSymbolicLinkFailedException.h ================================================================== --- src/exceptions/OFCreateSymbolicLinkFailedException.h +++ src/exceptions/OFCreateSymbolicLinkFailedException.h @@ -18,10 +18,14 @@ #import "OFException.h" #ifdef OF_HAVE_SYMLINK /*! + * @class OFCreateSymbolicLinkFailedException \ + * OFCreateSymbolicLinkFailedException.h \ + * ObjFW/OFCreateSymbolicLinkFailedException.h + * * @brief An exception indicating that creating a symbolic link failed. */ @interface OFCreateSymbolicLinkFailedException: OFException { OFString *_sourcePath, *_destinationPath; Index: src/exceptions/OFEnumerationMutationException.h ================================================================== --- src/exceptions/OFEnumerationMutationException.h +++ src/exceptions/OFEnumerationMutationException.h @@ -15,10 +15,14 @@ */ #import "OFException.h" /*! + * @class OFEnumerationMutationException \ + * OFEnumerationMutationException.h \ + * ObjFW/OFEnumerationMutationException.h + * * @brief An exception indicating that a mutation was detected during * enumeration. */ @interface OFEnumerationMutationException: OFException { Index: src/exceptions/OFException.h ================================================================== --- src/exceptions/OFException.h +++ src/exceptions/OFException.h @@ -130,10 +130,12 @@ # endif extern int of_wsaerr_to_errno(int); #endif /*! + * @class OFException OFException.h ObjFW/OFException.h + * * @brief The base class for all exceptions in ObjFW * * The OFException class is the base class for all exceptions in ObjFW, except * the OFAllocFailedException. */ Index: src/exceptions/OFHTTPRequestFailedException.h ================================================================== --- src/exceptions/OFHTTPRequestFailedException.h +++ src/exceptions/OFHTTPRequestFailedException.h @@ -22,10 +22,14 @@ @class OFHTTPRequest; @class OFHTTPResponse; /*! + * @class OFHTTPRequestFailedException \ + * OFHTTPRequestFailedException.h \ + * ObjFW/OFHTTPRequestFailedException.h + * * @brief An exception indicating that an HTTP request failed. */ @interface OFHTTPRequestFailedException: OFException { OFHTTPRequest *_request; Index: src/exceptions/OFHashAlreadyCalculatedException.h ================================================================== --- src/exceptions/OFHashAlreadyCalculatedException.h +++ src/exceptions/OFHashAlreadyCalculatedException.h @@ -16,10 +16,14 @@ #import "OFException.h" #import "OFHash.h" /*! + * @class OFHashAlreadyCalculatedException \ + * OFHashAlreadyCalculatedException.h \ + * ObjFW/OFHashAlreadyCalculatedException.h + * * @brief An exception indicating that the hash has already been calculated. */ @interface OFHashAlreadyCalculatedException: OFException { id _hashObject; Index: src/exceptions/OFInitializationFailedException.h ================================================================== --- src/exceptions/OFInitializationFailedException.h +++ src/exceptions/OFInitializationFailedException.h @@ -15,10 +15,14 @@ */ #import "OFException.h" /*! + * @class OFInitializationFailedException \ + * OFInitializationFailedException.h \ + * ObjFW/OFInitializationFailedException.h + * * @brief An exception indicating that initializing something failed. */ @interface OFInitializationFailedException: OFException { Class _inClass; Index: src/exceptions/OFInvalidArgumentException.h ================================================================== --- src/exceptions/OFInvalidArgumentException.h +++ src/exceptions/OFInvalidArgumentException.h @@ -15,9 +15,12 @@ */ #import "OFException.h" /*! + * @class OFInvalidArgumentException \ + * OFInvalidArgumentException.h ObjFW/OFInvalidArgumentException.h + * * @brief An exception indicating that the argument is invalid for this method. */ @interface OFInvalidArgumentException: OFException @end Index: src/exceptions/OFInvalidEncodingException.h ================================================================== --- src/exceptions/OFInvalidEncodingException.h +++ src/exceptions/OFInvalidEncodingException.h @@ -15,9 +15,12 @@ */ #import "OFException.h" /*! + * @class OFInvalidEncodingException \ + * OFInvalidEncodingException.h ObjFW/OFInvalidEncodingException.h + * * @brief An exception indicating that the encoding is invalid for this object. */ @interface OFInvalidEncodingException: OFException @end Index: src/exceptions/OFInvalidFormatException.h ================================================================== --- src/exceptions/OFInvalidFormatException.h +++ src/exceptions/OFInvalidFormatException.h @@ -15,9 +15,12 @@ */ #import "OFException.h" /*! + * @class OFInvalidFormatException \ + * OFInvalidFormatException.h ObjFW/OFInvalidFormatException.h + * * @brief An exception indicating that the format is invalid. */ @interface OFInvalidFormatException: OFException @end Index: src/exceptions/OFInvalidJSONException.h ================================================================== --- src/exceptions/OFInvalidJSONException.h +++ src/exceptions/OFInvalidJSONException.h @@ -15,10 +15,13 @@ */ #import "OFException.h" /*! + * @class OFInvalidJSONException \ + * OFInvalidJSONException.h ObjFW/OFInvalidJSONException.h + * * @brief An exception indicating a JSON representation is invalid. */ @interface OFInvalidJSONException: OFException { OFString *_string; Index: src/exceptions/OFInvalidServerReplyException.h ================================================================== --- src/exceptions/OFInvalidServerReplyException.h +++ src/exceptions/OFInvalidServerReplyException.h @@ -15,9 +15,12 @@ */ #import "OFException.h" /*! + * @class OFInvalidServerReplyException \ + * OFInvalidServerReplyException.h ObjFW/OFInvalidServerReplyException.h + * * @brief An exception indicating that the server sent an invalid reply. */ @interface OFInvalidServerReplyException: OFException @end Index: src/exceptions/OFLinkFailedException.h ================================================================== --- src/exceptions/OFLinkFailedException.h +++ src/exceptions/OFLinkFailedException.h @@ -18,10 +18,13 @@ #import "OFException.h" #ifdef OF_HAVE_LINK /*! + * @class OFLinkFailedException \ + * OFLinkFailedException.h ObjFW/OFLinkFailedException.h + * * @brief An exception indicating that creating a link failed. */ @interface OFLinkFailedException: OFException { OFString *_sourcePath, *_destinationPath; Index: src/exceptions/OFListenFailedException.h ================================================================== --- src/exceptions/OFListenFailedException.h +++ src/exceptions/OFListenFailedException.h @@ -21,10 +21,13 @@ #ifndef OF_HAVE_SOCKETS # error No sockets available! #endif /*! + * @class OFListenFailedException \ + * OFListenFailedException.h ObjFW/OFListenFailedException.h + * * @brief An exception indicating that listening on the socket failed. */ @interface OFListenFailedException: OFException { id _socket; Index: src/exceptions/OFLockFailedException.h ================================================================== --- src/exceptions/OFLockFailedException.h +++ src/exceptions/OFLockFailedException.h @@ -16,10 +16,13 @@ #import "OFException.h" #import "OFLocking.h" /*! + * @class OFLockFailedException \ + * OFLockFailedException.h ObjFW/OFLockFailedException.h + * * @brief An exception indicating that locking a lock failed. */ @interface OFLockFailedException: OFException { id _lock; Index: src/exceptions/OFMalformedXMLException.h ================================================================== --- src/exceptions/OFMalformedXMLException.h +++ src/exceptions/OFMalformedXMLException.h @@ -17,10 +17,13 @@ #import "OFException.h" @class OFXMLParser; /*! + * @class OFMalformedXMLException \ + * OFMalformedXMLException.h ObjFW/OFMalformedXMLException.h + * * @brief An exception indicating that a parser encountered malformed XML. */ @interface OFMalformedXMLException: OFException { OFXMLParser *_parser; Index: src/exceptions/OFMemoryNotPartOfObjectException.h ================================================================== --- src/exceptions/OFMemoryNotPartOfObjectException.h +++ src/exceptions/OFMemoryNotPartOfObjectException.h @@ -15,10 +15,14 @@ */ #import "OFException.h" /*! + * @class OFMemoryNotPartOfObjectException \ + * OFMemoryNotPartOfObjectException.h \ + * ObjFW/OFMemoryNotPartOfObjectException.h + * * @brief An exception indicating the given memory is not part of the object. */ @interface OFMemoryNotPartOfObjectException: OFException { void *_pointer; Index: src/exceptions/OFMoveItemFailedException.h ================================================================== --- src/exceptions/OFMoveItemFailedException.h +++ src/exceptions/OFMoveItemFailedException.h @@ -17,10 +17,13 @@ #include #import "OFException.h" /*! + * @class OFMoveItemFailedException \ + * OFMoveItemFailedException.h ObjFW/OFMoveItemFailedException.h + * * @brief An exception indicating that moving an item failed. */ @interface OFMoveItemFailedException: OFException { OFString *_sourcePath, *_destinationPath; Index: src/exceptions/OFNotConnectedException.h ================================================================== --- src/exceptions/OFNotConnectedException.h +++ src/exceptions/OFNotConnectedException.h @@ -19,10 +19,13 @@ #ifndef OF_HAVE_SOCKETS # error No sockets available! #endif /*! + * @class OFNotConnectedException \ + * OFNotConnectedException.h ObjFW/OFNotConnectedException.h + * * @brief An exception indicating a socket is not connected or bound. */ @interface OFNotConnectedException: OFException { id _socket; Index: src/exceptions/OFNotImplementedException.h ================================================================== --- src/exceptions/OFNotImplementedException.h +++ src/exceptions/OFNotImplementedException.h @@ -15,10 +15,13 @@ */ #import "OFException.h" /*! + * @class OFNotImplementedException \ + * OFNotImplementedException.h ObjFW/OFNotImplementedException.h + * * @brief An exception indicating that a method or part of it is not * implemented. */ @interface OFNotImplementedException: OFException { Index: src/exceptions/OFOpenFileFailedException.h ================================================================== --- src/exceptions/OFOpenFileFailedException.h +++ src/exceptions/OFOpenFileFailedException.h @@ -17,10 +17,13 @@ #include #import "OFException.h" /*! + * @class OFOpenFileFailedException \ + * OFOpenFileFailedException.h ObjFW/OFOpenFileFailedException.h + * * @brief An exception indicating a file couldn't be opened. */ @interface OFOpenFileFailedException: OFException { OFString *_path, *_mode; Index: src/exceptions/OFOutOfMemoryException.h ================================================================== --- src/exceptions/OFOutOfMemoryException.h +++ src/exceptions/OFOutOfMemoryException.h @@ -15,10 +15,13 @@ */ #import "OFException.h" /*! + * @class OFOutOfMemoryException \ + * OFOutOfMemoryException.h ObjFW/OFOutOfMemoryException.h + * * @brief An exception indicating there is not enough memory available. */ @interface OFOutOfMemoryException: OFException { size_t _requestedSize; Index: src/exceptions/OFOutOfRangeException.h ================================================================== --- src/exceptions/OFOutOfRangeException.h +++ src/exceptions/OFOutOfRangeException.h @@ -15,9 +15,12 @@ */ #import "OFException.h" /*! + * @class OFOutOfRangeException \ + * OFOutOfRangeException.h ObjFW/OFOutOfRangeException.h + * * @brief An exception indicating the given value is out of range. */ @interface OFOutOfRangeException: OFException @end Index: src/exceptions/OFReadFailedException.h ================================================================== --- src/exceptions/OFReadFailedException.h +++ src/exceptions/OFReadFailedException.h @@ -15,9 +15,12 @@ */ #import "OFReadOrWriteFailedException.h" /*! + * @class OFReadFailedException \ + * OFReadFailedException.h ObjFW/OFReadFailedException.h + * * @brief An exception indicating that reading from an object failed. */ @interface OFReadFailedException: OFReadOrWriteFailedException @end Index: src/exceptions/OFReadOrWriteFailedException.h ================================================================== --- src/exceptions/OFReadOrWriteFailedException.h +++ src/exceptions/OFReadOrWriteFailedException.h @@ -17,10 +17,13 @@ #include #import "OFException.h" /*! + * @class OFReadOrWriteFailedException \ + * OFReadOrWriteFailedException.h ObjFW/OFReadOrWriteFailedException.h + * * @brief An exception indicating that reading from or writing to an object * failed. */ @interface OFReadOrWriteFailedException: OFException { Index: src/exceptions/OFRemoveItemFailedException.h ================================================================== --- src/exceptions/OFRemoveItemFailedException.h +++ src/exceptions/OFRemoveItemFailedException.h @@ -17,10 +17,13 @@ #include #import "OFException.h" /*! + * @class OFRemoveItemFailedException \ + * OFRemoveItemFailedException.h ObjFW/OFRemoveItemFailedException.h + * * @brief An exception indicating that removing an item failed. */ @interface OFRemoveItemFailedException: OFException { OFString *_path; Index: src/exceptions/OFSeekFailedException.h ================================================================== --- src/exceptions/OFSeekFailedException.h +++ src/exceptions/OFSeekFailedException.h @@ -21,10 +21,13 @@ #import "OFException.h" @class OFSeekableStream; /*! + * @class OFSeekFailedException \ + * OFSeekFailedException.h ObjFW/OFSeekFailedException.h + * * @brief An exception indicating that seeking in a stream failed. */ @interface OFSeekFailedException: OFException { OFSeekableStream *_stream; Index: src/exceptions/OFSetOptionFailedException.h ================================================================== --- src/exceptions/OFSetOptionFailedException.h +++ src/exceptions/OFSetOptionFailedException.h @@ -17,10 +17,13 @@ #import "OFException.h" @class OFStream; /*! + * @class OFSetOptionFailedException \ + * OFSetOptionFailedException.h ObjFW/OFSetOptionFailedException.h + * * @brief An exception indicating that setting an option for a stream failed. */ @interface OFSetOptionFailedException: OFException { OFStream *_stream; Index: src/exceptions/OFStillLockedException.h ================================================================== --- src/exceptions/OFStillLockedException.h +++ src/exceptions/OFStillLockedException.h @@ -16,10 +16,13 @@ #import "OFException.h" #import "OFLocking.h" /*! + * @class OFStillLockedException \ + * OFStillLockedException.h ObjFW/OFStillLockedException.h + * * @brief An exception indicating that a lock is still locked. */ @interface OFStillLockedException: OFException { id _lock; Index: src/exceptions/OFThreadJoinFailedException.h ================================================================== --- src/exceptions/OFThreadJoinFailedException.h +++ src/exceptions/OFThreadJoinFailedException.h @@ -21,10 +21,13 @@ #endif @class OFThread; /*! + * @class OFThreadJoinFailedException \ + * OFThreadJoinFailedException.h ObjFW/OFThreadJoinFailedException.h + * * @brief An exception indicating that joining a thread failed. */ @interface OFThreadJoinFailedException: OFException { OFThread *_thread; Index: src/exceptions/OFThreadStartFailedException.h ================================================================== --- src/exceptions/OFThreadStartFailedException.h +++ src/exceptions/OFThreadStartFailedException.h @@ -21,10 +21,13 @@ #endif @class OFThread; /*! + * @class OFThreadStartFailedException \ + * OFThreadStartFailedException.h ObjFW/OFThreadStartFailedException.h + * * @brief An exception indicating that starting a thread failed. */ @interface OFThreadStartFailedException: OFException { OFThread *_thread; Index: src/exceptions/OFThreadStillRunningException.h ================================================================== --- src/exceptions/OFThreadStillRunningException.h +++ src/exceptions/OFThreadStillRunningException.h @@ -21,10 +21,13 @@ #endif @class OFThread; /*! + * @class OFThreadStillRunningException \ + * OFThreadStillRunningException.h ObjFW/OFThreadStillRunningException.h + * * @brief An exception indicating that a thread is still running. */ @interface OFThreadStillRunningException: OFException { OFThread *_thread; Index: src/exceptions/OFTruncatedDataException.h ================================================================== --- src/exceptions/OFTruncatedDataException.h +++ src/exceptions/OFTruncatedDataException.h @@ -15,10 +15,13 @@ */ #import "OFException.h" /*! + * @class OFTruncatedDataException \ + * OFTruncatedDataException.h ObjFW/OFTruncatedDataException.h + * * @brief An exception indicating that data was truncated while it should not * have been truncated. */ @interface OFTruncatedDataException: OFException @end Index: src/exceptions/OFUnboundNamespaceException.h ================================================================== --- src/exceptions/OFUnboundNamespaceException.h +++ src/exceptions/OFUnboundNamespaceException.h @@ -17,10 +17,13 @@ #import "OFException.h" @class OFXMLElement; /*! + * @class OFUnboundNamespaceException \ + * OFUnboundNamespaceException.h ObjFW/OFUnboundNamespaceException.h + * * @brief An exception indicating an attempt to use an unbound namespace. */ @interface OFUnboundNamespaceException: OFException { OFString *_namespace; Index: src/exceptions/OFUnboundPrefixException.h ================================================================== --- src/exceptions/OFUnboundPrefixException.h +++ src/exceptions/OFUnboundPrefixException.h @@ -17,10 +17,13 @@ #import "OFException.h" @class OFXMLParser; /*! + * @class OFUnboundPrefixException \ + * OFUnboundPrefixException.h ObjFW/OFUnboundPrefixException.h + * * @brief An exception indicating an attempt to use an unbound prefix. */ @interface OFUnboundPrefixException: OFException { OFString *_prefix; Index: src/exceptions/OFUnlockFailedException.h ================================================================== --- src/exceptions/OFUnlockFailedException.h +++ src/exceptions/OFUnlockFailedException.h @@ -16,10 +16,13 @@ #import "OFException.h" #import "OFLocking.h" /*! + * @class OFUnlockFailedException \ + * OFUnlockFailedException.h ObjFW/OFUnlockFailedException.h + * * @brief An exception indicating that unlocking a lock failed. */ @interface OFUnlockFailedException: OFException { id _lock; Index: src/exceptions/OFUnsupportedProtocolException.h ================================================================== --- src/exceptions/OFUnsupportedProtocolException.h +++ src/exceptions/OFUnsupportedProtocolException.h @@ -17,10 +17,14 @@ #import "OFException.h" @class OFURL; /*! + * @class OFUnsupportedProtocolException \ + * OFUnsupportedProtocolException.h \ + * ObjFW/OFUnsupportedProtocolException.h + * * @brief An exception indicating that the protocol specified by the URL is not * supported. */ @interface OFUnsupportedProtocolException: OFException { Index: src/exceptions/OFUnsupportedVersionException.h ================================================================== --- src/exceptions/OFUnsupportedVersionException.h +++ src/exceptions/OFUnsupportedVersionException.h @@ -15,10 +15,13 @@ */ #import "OFException.h" /*! + * @class OFUnsupportedVersionException \ + * OFUnsupportedVersionException.h ObjFW/OFUnsupportedVersionException.h + * * @brief An exception indicating that the specified version of the format or * protocol is not supported. */ @interface OFUnsupportedVersionException: OFException { Index: src/exceptions/OFWriteFailedException.h ================================================================== --- src/exceptions/OFWriteFailedException.h +++ src/exceptions/OFWriteFailedException.h @@ -15,9 +15,12 @@ */ #import "OFReadOrWriteFailedException.h" /*! + * @class OFWriteFailedException \ + * OFWriteFailedException.h ObjFW/OFWriteFailedException.h + * * @brief An exception indicating that writing to an object failed. */ @interface OFWriteFailedException: OFReadOrWriteFailedException @end Index: src/resolver.h ================================================================== --- src/resolver.h +++ src/resolver.h @@ -19,13 +19,15 @@ #import "socket.h" /*! @file */ /*! + * @struct of_resolver_result_t resolver.h ObjFW/resolver.h + * * @brief A struct representing one result from the resolver. */ -typedef struct of_resolver_result_t { +typedef struct { int family, type, protocol; struct sockaddr *address; socklen_t addressLength; void *private_; } of_resolver_result_t;