Index: src/OFApplication.h ================================================================== --- src/OFApplication.h +++ src/OFApplication.h @@ -144,27 +144,27 @@ @property (class, readonly, nullable, nonatomic) OFDictionary OF_GENERIC(OFString *, OFString *) *environment; #endif /*! - * The name of the program (argv[0]). + * @brief The name of the program (argv[0]). */ @property (readonly, nonatomic) OFString *programName; /*! - * The arguments passed to the application. + * @brief The arguments passed to the application. */ @property (readonly, nonatomic) OFArray OF_GENERIC(OFString *) *arguments; /*! - * The environment of the application. + * @brief The environment of the application. */ @property (readonly, nonatomic) OFDictionary OF_GENERIC(OFString *, OFString *) *environment; /*! - * The delegate of the application. + * @brief The delegate of the application. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) id delegate; /*! Index: src/OFArray.h ================================================================== --- src/OFArray.h +++ src/OFArray.h @@ -134,42 +134,42 @@ + (instancetype) arrayWithObjects: (ObjectType const _Nonnull *_Nonnull)objects count: (size_t)count; /*! - * The objects of the array as a C array. + * @brief The objects of the array as a C array. * * The result is valid until the autorelease pool is released. If you want to * use the result outside the scope of the current autorelease pool, you have to * copy it. */ @property (readonly, nonatomic) ObjectType const __unsafe_unretained _Nonnull *_Nonnull objects; /*! - * The first object of the array or `nil`. + * @brief The first object of the array or `nil`. * * @warning The returned object is *not* retained and autoreleased for * performance reasons! */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) ObjectType firstObject; /*! - * The last object of the array or `nil`. + * @brief The last object of the array or `nil`. * * @warning The returned object is *not* retained and autoreleased for * performance reasons! */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) ObjectType lastObject; /*! - * The array sorted in ascending order. + * @brief The array sorted in ascending order. */ @property (readonly, nonatomic) OFArray OF_GENERIC(ObjectType) *sortedArray; /*! - * The array with the order reversed. + * @brief The array with the order reversed. */ @property (readonly, nonatomic) OFArray OF_GENERIC(ObjectType) *reversedArray; /*! * @brief Initializes an OFArray with the specified object. Index: src/OFCharacterSet.h ================================================================== --- src/OFCharacterSet.h +++ src/OFCharacterSet.h @@ -24,12 +24,12 @@ * * @brief A class cluster representing a character set. */ @interface OFCharacterSet: OFObject /*! - * The inverted set, containing only the characters that do not exist in the - * receiver. + * @brief The inverted set, containing only the characters that do not exist in + * the receiver. */ @property (readonly, nonatomic) OFCharacterSet *invertedSet; /*! * @brief Creates a new character set containing the characters of the Index: src/OFCollection.h ================================================================== --- src/OFCollection.h +++ src/OFCollection.h @@ -23,11 +23,11 @@ * * @brief A protocol with methods common for all collections. */ @protocol OFCollection /*! - * @return The number of objects in the collection + * @brief The number of objects in the collection */ @property (readonly, nonatomic) size_t count; /*! * @brief Checks whether the collection contains an object equal to the Index: src/OFCryptoHash.h ================================================================== --- src/OFCryptoHash.h +++ src/OFCryptoHash.h @@ -32,16 +32,16 @@ @property (class, readonly, nonatomic) size_t digestSize; @property (class, readonly, nonatomic) size_t blockSize; #endif /*! - * A boolean whether the hash has already been calculated. + * @brief A boolean whether the hash has already been calculated. */ @property (readonly, nonatomic, getter=isCalculated) bool calculated; /*! - * A buffer containing the cryptographic hash. + * @brief A buffer containing the cryptographic hash. * * The size of the buffer depends on the hash used. The buffer is part of the * receiver's memory pool. */ @property (readonly, nonatomic) const unsigned char *digest Index: src/OFData+CryptoHashing.h ================================================================== --- src/OFData+CryptoHashing.h +++ src/OFData+CryptoHashing.h @@ -28,41 +28,41 @@ } #endif @interface OFData (CryptoHashing) /*! - * The MD5 hash of the data as a string. + * @brief The MD5 hash of the data as a string. */ @property (readonly, nonatomic) OFString *MD5Hash; /*! - * The RIPEMD-160 hash of the data as a string. + * @brief The RIPEMD-160 hash of the data as a string. */ @property (readonly, nonatomic) OFString *RIPEMD160Hash; /*! - * The SHA-1 hash of the data as a string. + * @brief The SHA-1 hash of the data as a string. */ @property (readonly, nonatomic) OFString *SHA1Hash; /*! - * The SHA-224 hash of the data as a string. + * @brief The SHA-224 hash of the data as a string. */ @property (readonly, nonatomic) OFString *SHA224Hash; /*! - * The SHA-256 hash of the data as a string. + * @brief The SHA-256 hash of the data as a string. */ @property (readonly, nonatomic) OFString *SHA256Hash; /*! - * The SHA-384 hash of the data as a string. + * @brief The SHA-384 hash of the data as a string. */ @property (readonly, nonatomic) OFString *SHA384Hash; /*! - * @return The SHA-512 hash of the data as a string. + * @brief The SHA-512 hash of the data as a string. */ @property (readonly, nonatomic) OFString *SHA512Hash; @end OF_ASSUME_NONNULL_END Index: src/OFData+MessagePackValue.h ================================================================== --- src/OFData+MessagePackValue.h +++ src/OFData+MessagePackValue.h @@ -26,11 +26,12 @@ } #endif @interface OFData (MessagePackValue) /*! - * The data interpreted as MessagePack representation and parsed as an object. + * @brief The data interpreted as MessagePack representation and parsed as an + * object. */ @property (readonly, nonatomic) id messagePackValue; /*! * @brief Parses the MessagePack representation and returns it as an object. Index: src/OFData.h ================================================================== --- src/OFData.h +++ src/OFData.h @@ -38,49 +38,48 @@ size_t _count, _itemSize; bool _freeWhenDone; } /*! - * The size of a single item in the OFData in bytes. + * @brief The size of a single item in the OFData in bytes. */ @property (readonly, nonatomic) size_t itemSize; /*! - * The number of items in the OFData. + * @brief The number of items in the OFData. */ @property (readonly, nonatomic) size_t count; /*! - * All elements of the OFData as a C array. + * @brief All elements of the OFData as a C array. * * @warning The pointer is only valid until the OFData is changed! - * */ @property (readonly, nonatomic) const void *items OF_RETURNS_INNER_POINTER; /*! - * The first item of the OFData or NULL. + * @brief The first item of the OFData or `NULL`. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) const void *firstItem OF_RETURNS_INNER_POINTER; /*! - * The last item of the OFData or NULL. + * @brief The last item of the OFData or `NULL`. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) const void *lastItem OF_RETURNS_INNER_POINTER; /*! - * The string representation of the data. + * @brief The string representation of the data. * * The string representation is a hex dump of the data, grouped by itemSize * bytes. */ @property (readonly, nonatomic) OFString *stringRepresentation; /*! - * A string containing the data in Base64 encoding. + * @brief A string containing the data in Base64 encoding. */ @property (readonly, nonatomic) OFString *stringByBase64Encoding; /*! * @brief Creates a new OFData with the specified `count` items of size 1. Index: src/OFDate.h ================================================================== --- src/OFDate.h +++ src/OFDate.h @@ -36,96 +36,96 @@ @property (class, readonly, nonatomic) OFDate *distantFuture; @property (class, readonly, nonatomic) OFDate *distantPast; #endif /*! - * The microsecond of the date. + * @brief The microsecond of the date. */ @property (readonly, nonatomic) uint32_t microsecond; /*! - * The second of the date. + * @brief The second of the date. */ @property (readonly, nonatomic) uint8_t second; /*! - * The minute of the date. + * @brief The minute of the date. */ @property (readonly, nonatomic) uint8_t minute; /*! - * The minute of the date in local time. + * @brief The minute of the date in local time. */ @property (readonly, nonatomic) uint8_t localMinute; /*! - * The hour of the date. + * @brief The hour of the date. */ @property (readonly, nonatomic) uint8_t hour; /*! - * The hour of the date in local time. + * @brief The hour of the date in local time. */ @property (readonly, nonatomic) uint8_t localHour; /*! - * The day of the month of the date. + * @brief The day of the month of the date. */ @property (readonly, nonatomic) uint8_t dayOfMonth; /*! - * The day of the month of the date in local time. + * @brief The day of the month of the date in local time. */ @property (readonly, nonatomic) uint8_t localDayOfMonth; /*! - * The month of the year of the date. + * @brief The month of the year of the date. */ @property (readonly, nonatomic) uint8_t monthOfYear; /*! - * The month of the year of the date in local time. + * @brief The month of the year of the date in local time. */ @property (readonly, nonatomic) uint8_t localMonthOfYear; /*! - * The year of the date. + * @brief The year of the date. */ @property (readonly, nonatomic) uint16_t year; /*! - * The year of the date in local time. + * @brief The year of the date in local time. */ @property (readonly, nonatomic) uint16_t localYear; /*! - * The day of the week of the date. + * @brief The day of the week of the date. */ @property (readonly, nonatomic) uint8_t dayOfWeek; /*! - * The day of the week of the date in local time. + * @brief The day of the week of the date in local time. */ @property (readonly, nonatomic) uint8_t localDayOfWeek; /*! - * The day of the year of the date. + * @brief The day of the year of the date. */ @property (readonly, nonatomic) uint16_t dayOfYear; /*! - * The day of the year of the date in local time. + * @brief The day of the year of the date in local time. */ @property (readonly, nonatomic) uint16_t localDayOfYear; /*! - * The seconds since 1970-01-01T00:00:00Z. + * @brief The seconds since 1970-01-01T00:00:00Z. */ @property (readonly, nonatomic) of_time_interval_t timeIntervalSince1970; /*! - * The seconds the date is in the future. + * @brief The seconds the date is in the future. */ @property (readonly, nonatomic) of_time_interval_t timeIntervalSinceNow; /*! * @brief Creates a new OFDate with the current date and time. Index: src/OFDictionary.h ================================================================== --- src/OFDictionary.h +++ src/OFDictionary.h @@ -116,21 +116,21 @@ */ + (instancetype)dictionaryWithKeysAndObjects: (KeyType)firstKey, ... OF_SENTINEL; /*! - * An array of all keys. + * @brief An array of all keys. */ @property (readonly, nonatomic) OFArray OF_GENERIC(KeyType) *allKeys; /*! - * An array of all objects. + * @brief An array of all objects. */ @property (readonly, nonatomic) OFArray OF_GENERIC(ObjectType) *allObjects; /*! - * A URL-encoded string with the contents of the dictionary. + * @brief A URL-encoded string with the contents of the dictionary. */ @property (readonly, nonatomic) OFString *stringByURLEncoding; /*! * @brief Initializes an already allocated OFDictionary with the specified Index: src/OFEnumerator.h ================================================================== --- src/OFEnumerator.h +++ src/OFEnumerator.h @@ -44,16 +44,16 @@ @interface OFEnumerator OF_GENERIC(ObjectType): OFObject #if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN) # define ObjectType id #endif /*! - * An array of all remaining objects in the collection. + * @brief An array of all remaining objects in the collection. */ @property (readonly, nonatomic) OFArray OF_GENERIC(ObjectType) *allObjects; /*! - * Returns the next object or `nil` if there is none left. + * @brief Returns the next object or `nil` if there is none left. * * @return The next object or `nil` if there is none left */ - (nullable ObjectType)nextObject; Index: src/OFFileManager.h ================================================================== --- src/OFFileManager.h +++ src/OFFileManager.h @@ -233,16 +233,16 @@ #ifdef OF_HAVE_CLASS_PROPERTIES @property (class, readonly, nonatomic) OFFileManager *defaultManager; #endif /*! - * The path of the current working directory. + * @brief The path of the current working directory. */ @property (readonly, nonatomic) OFString *currentDirectoryPath; /*! - * The URL of the current working directory. + * @brief The URL of the current working directory. */ @property (readonly, nonatomic) OFURL *currentDirectoryURL; /*! * @brief Returns the default file manager. Index: src/OFHMAC.h ================================================================== --- src/OFHMAC.h +++ src/OFHMAC.h @@ -31,25 +31,25 @@ id _Nullable _outerHashCopy, _innerHashCopy; bool _calculated; } /*! - * The class for the cryptographic hash used by the HMAC. + * @brief The class for the cryptographic hash used by the HMAC. */ @property (readonly, nonatomic) Class hashClass; /*! - * A buffer containing the HMAC. + * @brief A buffer containing the HMAC. * * The size of the buffer depends on the hash used. The buffer is part of the * receiver's memory pool. */ @property (readonly, nonatomic) const unsigned char *digest OF_RETURNS_INNER_POINTER; /*! - * The size of the digest. + * @brief The size of the digest. */ @property (readonly, nonatomic) size_t digestSize; /*! * @brief Returns a new OFHMAC with the specified hashing algorithm. Index: src/OFHTTPClient.h ================================================================== --- src/OFHTTPClient.h +++ src/OFHTTPClient.h @@ -152,17 +152,17 @@ bool _lastWasHEAD; OFHTTPResponse *_Nullable _lastResponse; } /*! - * The delegate of the HTTP request. + * @brief The delegate of the HTTP request. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) OFObject *delegate; /*! - * Whether redirects from HTTPS to HTTP will be allowed. + * @brief Whether redirects from HTTPS to HTTP will be allowed. */ @property (nonatomic) bool insecureRedirectsAllowed; /*! * @brief Creates a new OFHTTPClient. Index: src/OFHTTPCookie.h ================================================================== --- src/OFHTTPCookie.h +++ src/OFHTTPCookie.h @@ -37,46 +37,46 @@ bool _secure, _HTTPOnly; OFMutableArray OF_GENERIC(OFString *) *_extensions; } /*! - * The name of the cookie. + * @brief The name of the cookie. */ @property (copy, nonatomic) OFString *name; /*! - * The value of the cookie. + * @brief The value of the cookie. */ @property (copy, nonatomic) OFString *value; /*! - * The domain for the cookie. + * @brief The domain for the cookie. */ @property (copy, nonatomic) OFString *domain; /*! - * The path for the cookie. + * @brief The path for the cookie. */ @property (copy, nonatomic) OFString *path; /*! - * The date when the cookie expires. + * @brief The date when the cookie expires. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFDate *expires; /*! - * Whether the cookie is only to be used with HTTPS. + * @brief Whether the cookie is only to be used with HTTPS. */ @property (nonatomic, getter=isSecure) bool secure; /*! - * Whether the cookie is only to be accessed through HTTP. + * @brief Whether the cookie is only to be accessed through HTTP. */ @property (nonatomic, getter=isHTTPOnly) bool HTTPOnly; /*! - * An array of other attributes. + * @brief An array of other attributes. */ @property (readonly, nonatomic) OFMutableArray OF_GENERIC(OFString *) *extensions; /*! Index: src/OFHTTPCookieManager.h ================================================================== --- src/OFHTTPCookieManager.h +++ src/OFHTTPCookieManager.h @@ -32,11 +32,11 @@ { OFMutableArray OF_GENERIC(OFHTTPCookie *) *_cookies; } /*! - * All cookies known to the cookie manager. + * @brief All cookies known to the cookie manager. */ @property (readonly, nonatomic) OFArray OF_GENERIC(OFHTTPCookie *) *cookies; /*! * @brief Create a new cookie manager. Index: src/OFHTTPRequest.h ================================================================== --- src/OFHTTPRequest.h +++ src/OFHTTPRequest.h @@ -75,42 +75,42 @@ OFData *_Nullable _body; OFString *_Nullable _remoteAddress; } /*! - * The URL of the HTTP request. + * @brief The URL of the HTTP request. */ @property (copy, nonatomic) OFURL *URL; /*! - * The protocol version of the HTTP request. + * @brief The protocol version of the HTTP request. */ @property (nonatomic) of_http_request_protocol_version_t protocolVersion; /*! - * The protocol version of the HTTP request as a string. + * @brief The protocol version of the HTTP request as a string. */ @property (readonly, nonatomic) OFString *protocolVersionString; /*! - * The request method of the HTTP request. + * @brief The request method of the HTTP request. */ @property (nonatomic) of_http_request_method_t method; /*! - * The headers for the HTTP request. + * @brief The headers for the HTTP request. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFDictionary OF_GENERIC(OFString *, OFString *) *headers; /*! - * The entity body of the HTTP request. + * @brief The entity body of the HTTP request. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFData *body; /*! - * The remote address from which the request originates. + * @brief The remote address from which the request originates. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *remoteAddress; /*! * @brief Creates a new OFHTTPRequest. Index: src/OFHTTPResponse.h ================================================================== --- src/OFHTTPResponse.h +++ src/OFHTTPResponse.h @@ -33,32 +33,32 @@ short _statusCode; OFDictionary OF_GENERIC(OFString *, OFString *) *_headers; } /*! - * The protocol version of the HTTP request reply. + * @brief The protocol version of the HTTP request reply. */ @property (nonatomic) of_http_request_protocol_version_t protocolVersion; /*! - * The protocol version of the HTTP request reply as a string. + * @brief The protocol version of the HTTP request reply as a string. */ @property (readonly, nonatomic) OFString *protocolVersionString; /*! - * The status code of the reply to the HTTP request. + * @brief The status code of the reply to the HTTP request. */ @property (nonatomic) short statusCode; /*! - * The headers of the reply to the HTTP request. + * @brief The headers of the reply to the HTTP request. */ @property (copy, nonatomic) OFDictionary OF_GENERIC(OFString *, OFString *) *headers; /*! - * The reply as a string, trying to detect the encoding. + * @brief The reply as a string, trying to detect the encoding. */ @property (readonly, nonatomic) OFString *string; /*! * @brief Sets the protocol version of the HTTP request reply to the version Index: src/OFHTTPServer.h ================================================================== --- src/OFHTTPServer.h +++ src/OFHTTPServer.h @@ -93,27 +93,27 @@ OFString *_Nullable _name; OFTCPSocket *_Nullable _listeningSocket; } /*! - * The host on which the HTTP server will listen. + * @brief The host on which the HTTP server will listen. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *host; /*! - * The port on which the HTTP server will listen. + * @brief The port on which the HTTP server will listen. */ @property (nonatomic) uint16_t port; /*! - * The delegate for the HTTP server. + * @brief The delegate for the HTTP server. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) id delegate; /*! - * The server name the server presents to clients. + * @brief The server name the server presents to clients. * * Setting it to `nil` means no `Server` header will be sent, unless one is * specified in the response headers. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *name; Index: src/OFINICategory.h ================================================================== --- src/OFINICategory.h +++ src/OFINICategory.h @@ -32,11 +32,11 @@ OFString *_name; OFMutableArray *_lines; } /*! - * The name of the INI category + * @brief The name of the INI category */ @property (copy, nonatomic) OFString *name; - (instancetype)init OF_UNAVAILABLE; Index: src/OFIntrospection.h ================================================================== --- src/OFIntrospection.h +++ src/OFIntrospection.h @@ -46,21 +46,21 @@ OFString *_name; const char *_typeEncoding; } /*! - * The selector of the method. + * @brief The selector of the method. */ @property (readonly, nonatomic) SEL selector; /*! - * The name of the method. + * @brief The name of the method. */ @property (readonly, nonatomic) OFString *name; /*! - * The type encoding for the method. + * @brief The type encoding for the method. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) const char *typeEncoding; - (instancetype)init OF_UNAVAILABLE; @end @@ -76,16 +76,16 @@ unsigned int _attributes; OFString *_Nullable _getter, *_Nullable _setter; } /*! - * The name of the property. + * @brief The name of the property. */ @property (readonly, nonatomic) OFString *name; /*! - * The attributes of the property. + * @brief The attributes of the property. * * The attributes are a bitmask with the following possible flags:@n * Flag | Description * ------------------------------|------------------------------------- * OF_PROPERTY_READONLY | The property is declared `readonly` @@ -100,16 +100,16 @@ * OF_PROPERTY_DYNAMIC | The property is dynamic */ @property (readonly, nonatomic) unsigned int attributes; /*! - * The name of the getter. + * @brief The name of the getter. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *getter; /*! - * @return The name of the setter. + * @brief The name of the setter. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *setter; - (instancetype)init OF_UNAVAILABLE; @end @@ -125,21 +125,21 @@ const char *_typeEncoding; ptrdiff_t _offset; } /*! - * The name of the instance variable. + * @brief The name of the instance variable. */ @property (readonly, nonatomic) OFString *name; /*! - * The offset of the instance variable. + * @brief The offset of the instance variable. */ @property (readonly, nonatomic) ptrdiff_t offset; /*! - * The type encoding for the instance variable. + * @brief The type encoding for the instance variable. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) const char *typeEncoding; - (instancetype)init OF_UNAVAILABLE; @end @@ -156,21 +156,21 @@ OFMutableArray OF_GENERIC(OFProperty *) *_properties; OFMutableArray OF_GENERIC(OFInstanceVariable *) *_instanceVariables; } /*! - * The class methods of the class. + * @brief The class methods of the class. */ @property (readonly, nonatomic) OFArray OF_GENERIC(OFMethod *) *classMethods; /*! - * The instance methods of the class. + * @brief The instance methods of the class. */ @property (readonly, nonatomic) OFArray OF_GENERIC(OFMethod *) *instanceMethods; /*! - * The properties of the class. + * @brief The properties of the class. * * @warning **Do not rely on this, as this behaves differently depending on the * compiler and ABI used!** * * @warning For the ObjFW ABI, Clang only emits data for property introspection @@ -188,11 +188,11 @@ * ABI. */ @property (readonly, nonatomic) OFArray OF_GENERIC(OFProperty *) *properties; /*! - * The instance variables of the class. + * @brief The instance variables of the class. */ @property (readonly, nonatomic) OFArray OF_GENERIC(OFInstanceVariable *) *instanceVariables; /* TODO: protocols */ Index: src/OFInvocation.h ================================================================== --- src/OFInvocation.h +++ src/OFInvocation.h @@ -45,11 +45,11 @@ OFMutableArray OF_GENERIC(OFMutableData *) *_arguments; OFMutableData *_returnValue; } /*! - * The method signature for the invocation. + * @brief The method signature for the invocation. */ @property (readonly, nonatomic) OFMethodSignature *methodSignature; /*! * @brief Creates a new invocation with the specified method signature. Index: src/OFJSONRepresentation.h ================================================================== --- src/OFJSONRepresentation.h +++ src/OFJSONRepresentation.h @@ -35,11 +35,11 @@ * OFArray and OFDictionary, this will generate invalid JSON, as JSON * requires all data to be encapsulated in an array or a dictionary! */ @protocol OFJSONRepresentation /*! - * The JSON representation of the object as a string. + * @brief The JSON representation of the object as a string. */ @property (readonly, nonatomic) OFString *JSONRepresentation; /*! * @brief Returns the JSON representation of the object as a string. Index: src/OFKernelEventObserver.h ================================================================== --- src/OFKernelEventObserver.h +++ src/OFKernelEventObserver.h @@ -67,12 +67,12 @@ * @brief This protocol is implemented by classes which can be observed for * readiness for reading by OFKernelEventObserver. */ @protocol OFReadyForReadingObserving /*! - * The file descriptor for reading that should be checked by the - * OFKernelEventObserver. + * @brief The file descriptor for reading that should be checked by the + * OFKernelEventObserver. */ @property (readonly, nonatomic) int fileDescriptorForReading; @end /*! @@ -82,12 +82,12 @@ * @brief This protocol is implemented by classes which can be observed for * readiness for writing by OFKernelEventObserver. */ @protocol OFReadyForWritingObserving /*! - * The file descriptor for writing that should be checked by the - * OFKernelEventObserver. + * @brief The file descriptor for writing that should be checked by the + * OFKernelEventObserver. */ @property (readonly, nonatomic) int fileDescriptorForWriting; @end /*! @@ -118,11 +118,11 @@ OFMutableData *_queueActions; OFMutableArray *_queueObjects; } /*! - * The delegate for the OFKernelEventObserver. + * @brief The delegate for the OFKernelEventObserver. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) id delegate; /*! Index: src/OFList.h ================================================================== --- src/OFList.h +++ src/OFList.h @@ -55,31 +55,31 @@ size_t _count; unsigned long _mutations; } /*! - * The first list object of the list. + * @brief The first list object of the list. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) of_list_object_t *firstListObject; /*! - * The first object of the list or `nil`. + * @brief The first object of the list or `nil`. * * @warning The returned object is *not* retained and autoreleased for * performance reasons! */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) ObjectType firstObject; /*! - * The last list object of the list. + * @brief The last list object of the list. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) of_list_object_t *lastListObject; /*! - * The last object of the list or `nil`. + * @brief The last object of the list or `nil`. * * @warning The returned object is *not* retained and autoreleased for * performance reasons! */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) ObjectType lastObject; Index: src/OFLocalization.h ================================================================== --- src/OFLocalization.h +++ src/OFLocalization.h @@ -60,35 +60,35 @@ @property (class, readonly, nonatomic) of_string_encoding_t encoding; @property (class, readonly, nullable, nonatomic) OFString *decimalPoint; #endif /*! - * The language of the locale for messages. + * @brief The language of the locale for messages. * * If the language is unknown, it is `nil`. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *language; /*! - * The territory of the locale for messages. + * @brief The territory of the locale for messages. * * If the territory is unknown, it is `nil`. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *territory; /*! - * The native 8-bit string encoding of the locale for messages. + * @brief The native 8-bit string encoding of the locale for messages. * * This is useful to encode strings correctly for passing them to operating * system calls. * * If the native 8-bit encoding is unknown, UTF-8 is assumed. */ @property (readonly, nonatomic) of_string_encoding_t encoding; /*! - * The decimal point of the system's locale. + * @brief The decimal point of the system's locale. */ @property (readonly, nonatomic) OFString *decimalPoint; /*! * @brief Returns the shared OFLocalization instance. Index: src/OFLocking.h ================================================================== --- src/OFLocking.h +++ src/OFLocking.h @@ -23,11 +23,11 @@ * * @brief A protocol for locks. */ @protocol OFLocking /*! - * The name of the lock. + * @brief The name of the lock. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *name; /*! * @brief Locks the lock. Index: src/OFMapTable.h ================================================================== --- src/OFMapTable.h +++ src/OFMapTable.h @@ -77,21 +77,21 @@ uint8_t _rotate; unsigned long _mutations; } /*! - * The key functions used by the map table. + * @brief The key functions used by the map table. */ @property (readonly, nonatomic) of_map_table_functions_t keyFunctions; /*! - * The object functions used by the map table. + * @brief The object functions used by the map table. */ @property (readonly, nonatomic) of_map_table_functions_t objectFunctions; /*! - * The number of objects in the map table. + * @brief The number of objects in the map table. */ @property (readonly, nonatomic) size_t count; /*! * @brief Creates a new OFMapTable with the specified key and object functions. Index: src/OFMessagePackExtension.h ================================================================== --- src/OFMessagePackExtension.h +++ src/OFMessagePackExtension.h @@ -33,16 +33,16 @@ int8_t _type; OFData *_data; } /*! - * The MessagePack extension type. + * @brief The MessagePack extension type. */ @property (readonly, nonatomic) int8_t type; /*! - * @return The data of the extension. + * @brief The data of the extension. */ @property (readonly, nonatomic) OFData *data; /*! * @brief Creates a new OFMessagePackRepresentation with the specified type and Index: src/OFMessagePackRepresentation.h ================================================================== --- src/OFMessagePackRepresentation.h +++ src/OFMessagePackRepresentation.h @@ -27,11 +27,11 @@ * @brief A protocol implemented by classes that support encoding to a * MessagePack representation. */ @protocol OFMessagePackRepresentation /*! - * @return The MessagePack representation of the object as OFData. + * @brief The MessagePack representation of the object as OFData. */ @property (readonly, nonatomic) OFData *messagePackRepresentation; @end OF_ASSUME_NONNULL_END Index: src/OFMethodSignature.h ================================================================== --- src/OFMethodSignature.h +++ src/OFMethodSignature.h @@ -30,21 +30,21 @@ char *_types; OFMutableData *_typesPointers, *_offsets; } /*! - * The number of arguments of the method. + * @brief The number of arguments of the method. */ @property (readonly, nonatomic) size_t numberOfArguments; /*! - * The return type of the method. + * @brief The return type of the method. */ @property (readonly, nonatomic) const char *methodReturnType; /*! - * The size of the arguments on the stack frame. + * @brief The size of the arguments on the stack frame. * * @note This is platform-dependent! */ @property (readonly, nonatomic) size_t frameLength; Index: src/OFMutableData.h ================================================================== --- src/OFMutableData.h +++ src/OFMutableData.h @@ -197,30 +197,30 @@ @interface OFMutableData (MutableRetrieving) /* GCC does not like overriding properties with a different type. */ #if defined(__clang__) || defined(DOXYGEN) /*! - * All items of the OFMutableData as a C array. + * @brief All items of the OFMutableData as a C array. * * @warning The pointer is only valid until the OFMutableData is changed! * * Modifying the returned array directly is allowed and will change the contents * of the data array. */ @property (readonly, nonatomic) void *items OF_RETURNS_INNER_POINTER; /*! - * The first item of the OFMutableData or NULL. + * @brief The first item of the OFMutableData or `NULL`. * * Modifying the returned item directly is allowed and will change the contents * of the data array. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) void *firstItem OF_RETURNS_INNER_POINTER; /*! - * Last item of the OFMutableData or NULL. + * @brief Last item of the OFMutableData or `NULL`. * * Modifying the returned item directly is allowed and will change the contents * of the data array. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) void *lastItem Index: src/OFMutablePair.h ================================================================== --- src/OFMutablePair.h +++ src/OFMutablePair.h @@ -28,16 +28,16 @@ #if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN) # define FirstType id # define SecondType id #endif /*! - * The first object of the pair. + * @brief The first object of the pair. */ @property (readwrite, nonatomic, retain) FirstType firstObject; /*! - * The second object of the pair. + * @brief The second object of the pair. */ @property (readwrite, nonatomic, retain) SecondType secondObject; /*! * @brief Converts the mutable pair to an immutable pair. Index: src/OFMutableTarArchiveEntry.h ================================================================== --- src/OFMutableTarArchiveEntry.h +++ src/OFMutableTarArchiveEntry.h @@ -25,69 +25,69 @@ * @brief A class which represents a mutable entry of a tar archive. */ @interface OFMutableTarArchiveEntry: OFTarArchiveEntry /*! - * The file name of the entry. + * @brief The file name of the entry. */ @property (readwrite, copy, nonatomic) OFString *fileName; /*! - * The mode of the entry. + * @brief The mode of the entry. */ @property (readwrite, nonatomic) uint32_t mode; /*! - * The UID of the owner. + * @brief The UID of the owner. */ @property (readwrite, nonatomic) uint32_t UID; /*! - * The GID of the group. + * @brief The GID of the group. */ @property (readwrite, nonatomic) uint32_t GID; /*! - * The size of the file. + * @brief The size of the file. */ @property (readwrite, nonatomic) uint64_t size; /*! - * The date of the last modification of the file. + * @brief The date of the last modification of the file. */ @property (readwrite, retain, nonatomic) OFDate *modificationDate; /*! - * The type of the archive entry. + * @brief The type of the archive entry. * * See @ref of_tar_archive_entry_type_t. */ @property (readwrite, nonatomic) of_tar_archive_entry_type_t type; /*! - * The file name of the target (for a hard link or symbolic link). + * @brief The file name of the target (for a hard link or symbolic link). */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *targetFileName; /*! - * The owner of the file. + * @brief The owner of the file. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *owner; /*! - * The group of the file. + * @brief The group of the file. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *group; /*! - * The device major (if the file is a device). + * @brief The device major (if the file is a device). */ @property (readwrite, nonatomic) uint32_t deviceMajor; /*! - * The device major (if the file is a device). + * @brief The device major (if the file is a device). */ @property (readwrite, nonatomic) uint32_t deviceMinor; /*! * @brief Converts the OFMutableTarArchiveEntry to an immutable Index: src/OFMutableTriple.h ================================================================== --- src/OFMutableTriple.h +++ src/OFMutableTriple.h @@ -29,21 +29,21 @@ # define FirstType id # define SecondType id # define ThirdType id #endif /*! - * The first object of the triple. + * @brief The first object of the triple. */ @property (readwrite, nonatomic, retain) FirstType firstObject; /*! - * The second object of the triple. + * @brief The second object of the triple. */ @property (readwrite, nonatomic, retain) SecondType secondObject; /*! - * The third object of the triple. + * @brief The third object of the triple. */ @property (readwrite, nonatomic, retain) ThirdType thirdObject; /*! * @brief Converts the mutable triple to an immutable triple. Index: src/OFMutableURL.h ================================================================== --- src/OFMutableURL.h +++ src/OFMutableURL.h @@ -23,113 +23,113 @@ * * @brief A class for parsing URLs and accessing parts of it. */ @interface OFMutableURL: OFURL /*! - * The scheme part of the URL. + * @brief The scheme part of the URL. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *scheme; /*! - * The scheme part of the URL in URL-encoded form. + * @brief The scheme part of the URL in URL-encoded form. * * Setting this retains the original URL-encoding used - if more characters * than necessary are URL-encoded, it is kept this way. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *URLEncodedScheme; /*! - * The host part of the URL. + * @brief The host part of the URL. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *host; /*! - * The host part of the URL in URL-encoded form. + * @brief The host part of the URL in URL-encoded form. * * Setting this retains the original URL-encoding used - if more characters * than necessary are URL-encoded, it is kept this way. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *URLEncodedHost; /*! - * The port part of the URL. + * @brief The port part of the URL. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFNumber *port; /*! - * The user part of the URL. + * @brief The user part of the URL. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *user; /*! - * The user part of the URL in URL-encoded form. + * @brief The user part of the URL in URL-encoded form. * * Setting this retains the original URL-encoding used - if more characters * than necessary are URL-encoded, it is kept this way. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *URLEncodedUser; /*! - * The password part of the URL. + * @brief The password part of the URL. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *password; /*! - * The password part of the URL in URL-encoded form. + * @brief The password part of the URL in URL-encoded form. * * Setting this retains the original URL-encoding used - if more characters * than necessary are URL-encoded, it is kept this way. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *URLEncodedPassword; /*! - * The path part of the URL. + * @brief The path part of the URL. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *path; /*! - * The path part of the URL in URL-encoded form. + * @brief The path part of the URL in URL-encoded form. * * Setting this retains the original URL-encoding used - if more characters * than necessary are URL-encoded, it is kept this way. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *URLEncodedPath; /*! - * The path of the URL split into components. + * @brief The path of the URL split into components. * * The first component must always be empty to designate the root. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFArray OF_GENERIC(OFString *) *pathComponents; /*! - * The query part of the URL. + * @brief The query part of the URL. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *query; /*! - * The query part of the URL in URL-encoded form. + * @brief The query part of the URL in URL-encoded form. * * Setting this retains the original URL-encoding used - if more characters * than necessary are URL-encoded, it is kept this way. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *URLEncodedQuery; /*! - * The fragment part of the URL. + * @brief The fragment part of the URL. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *fragment; /*! - * The fragment part of the URL in URL-encoded form. + * @brief The fragment part of the URL in URL-encoded form. * * Setting this retains the original URL-encoding used - if more characters * than necessary are URL-encoded, it is kept this way. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) Index: src/OFMutableZIPArchiveEntry.h ================================================================== --- src/OFMutableZIPArchiveEntry.h +++ src/OFMutableZIPArchiveEntry.h @@ -26,54 +26,54 @@ * a ZIP archive. */ @interface OFMutableZIPArchiveEntry: OFZIPArchiveEntry /*! - * The file name of the entry. + * @brief The file name of the entry. */ @property (readwrite, copy, nonatomic) OFString *fileName; /*! - * The comment of the entry's file. + * @brief The comment of the entry's file. */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *fileComment; /*! - * The extra field of the entry. + * @brief The extra field of the entry. * * The item size *must* be 1! */ @property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFData *extraField; /*! - * The version which made the entry. + * @brief The version which made the entry. * * The lower 8 bits are the ZIP specification version.@n * The upper 8 bits are the attribute compatibility. * See @ref of_zip_archive_entry_attribute_compatibility. */ @property (readwrite, nonatomic) uint16_t versionMadeBy; /*! - * The minimum version required to extract the file. + * @brief The minimum version required to extract the file. * * The lower 8 bits are the ZIP specification version.@n * The upper 8 bits are the attribute compatibility. * See @ref of_zip_archive_entry_attribute_compatibility. */ @property (readwrite, nonatomic) uint16_t minVersionNeeded; /*! - * The last modification date of the entry's file. + * @brief The last modification date of the entry's file. * * @note Due to limitations of the ZIP format, this has only 2 second precision. */ @property (readwrite, retain, nonatomic) OFDate *modificationDate; /*! - * The compression method of the entry. + * @brief The compression method of the entry. * * Supported values are: * Value | Description * --------------------------------------------------|--------------- * OF_ZIP_ARCHIVE_ENTRY_COMPRESSION_METHOD_NONE | No compression @@ -83,34 +83,34 @@ * Other values may be returned, but the file cannot be extracted then. */ @property (readwrite, nonatomic) uint16_t compressionMethod; /*! - * The compressed size of the entry's file. + * @brief The compressed size of the entry's file. */ @property (readwrite, nonatomic) uint64_t compressedSize; /*! - * The uncompressed size of the entry's file. + * @brief The uncompressed size of the entry's file. */ @property (readwrite, nonatomic) uint64_t uncompressedSize; /*! - * The CRC32 checksum of the entry's file. + * @brief The CRC32 checksum of the entry's file. */ @property (readwrite, nonatomic) uint32_t CRC32; /*! - * The version specific attributes. + * @brief The version specific attributes. * * The meaning of the version specific attributes depends on the attribute * compatibility part of the version that made the entry. */ @property (readwrite, nonatomic) uint32_t versionSpecificAttributes; /*! - * The general purpose bit flag of the entry. + * @brief The general purpose bit flag of the entry. * * See the ZIP specification for details. */ @property (readwrite, nonatomic) uint16_t generalPurposeBitFlag; Index: src/OFNumber.h ================================================================== --- src/OFNumber.h +++ src/OFNumber.h @@ -38,77 +38,77 @@ /*! * @brief The C type of a number stored in an OFNumber. */ typedef enum { - /*! bool */ + /*! `bool` */ OF_NUMBER_TYPE_BOOL = 0x01, - /*! unsigned char */ + /*! `unsigned char` */ OF_NUMBER_TYPE_UCHAR = 0x02, - /*! unsigned short */ + /*! `unsigned short` */ OF_NUMBER_TYPE_USHORT = 0x03, - /*! unsigned int */ + /*! `unsigned int` */ OF_NUMBER_TYPE_UINT = 0x04, - /*! unsigned long */ + /*! `unsigned long` */ OF_NUMBER_TYPE_ULONG = 0x05, - /*! unsigned long long */ + /*! `unsigned long long` */ OF_NUMBER_TYPE_ULONGLONG = 0x06, - /*! size_t */ + /*! `size_t` */ OF_NUMBER_TYPE_SIZE = 0x07, - /*! uint8_t */ + /*! `uint8_t` */ OF_NUMBER_TYPE_UINT8 = 0x08, - /*! uint16_t */ + /*! `uint16_t` */ OF_NUMBER_TYPE_UINT16 = 0x09, - /*! uint32_t */ + /*! `uint32_t` */ OF_NUMBER_TYPE_UINT32 = 0x0A, - /*! uint64_t */ + /*! `uint64_t` */ OF_NUMBER_TYPE_UINT64 = 0x0B, - /*! uintptr_t */ + /*! `uintptr_t` */ OF_NUMBER_TYPE_UINTPTR = 0x0C, - /*! uintmax_t */ + /*! `uintmax_t` */ OF_NUMBER_TYPE_UINTMAX = 0x0D, OF_NUMBER_TYPE_SIGNED = 0x10, - /*! signed char */ + /*! `signed char` */ OF_NUMBER_TYPE_CHAR = OF_NUMBER_TYPE_UCHAR | OF_NUMBER_TYPE_SIGNED, - /*! signed short */ + /*! `signed short` */ OF_NUMBER_TYPE_SHORT = OF_NUMBER_TYPE_USHORT | OF_NUMBER_TYPE_SIGNED, - /*! signed int */ + /*! `signed int` */ OF_NUMBER_TYPE_INT = OF_NUMBER_TYPE_UINT | OF_NUMBER_TYPE_SIGNED, - /*! signed long */ + /*! `signed long` */ OF_NUMBER_TYPE_LONG = OF_NUMBER_TYPE_ULONG | OF_NUMBER_TYPE_SIGNED, - /*! signed long long */ + /*! `signed long long` */ OF_NUMBER_TYPE_LONGLONG = OF_NUMBER_TYPE_ULONGLONG | OF_NUMBER_TYPE_SIGNED, - /*! int8_t */ + /*! `int8_t` */ OF_NUMBER_TYPE_INT8 = OF_NUMBER_TYPE_UINT8 | OF_NUMBER_TYPE_SIGNED, - /*! int16_t */ + /*! `int16_t` */ OF_NUMBER_TYPE_INT16 = OF_NUMBER_TYPE_UINT16 | OF_NUMBER_TYPE_SIGNED, - /*! int32_t */ + /*! `int32_t` */ OF_NUMBER_TYPE_INT32 = OF_NUMBER_TYPE_UINT32 | OF_NUMBER_TYPE_SIGNED, - /*! int64_t */ + /*! `int64_t` */ OF_NUMBER_TYPE_INT64 = OF_NUMBER_TYPE_UINT64 | OF_NUMBER_TYPE_SIGNED, - /*! ssize_t */ + /*! `ssize_t` */ OF_NUMBER_TYPE_SSIZE = OF_NUMBER_TYPE_SIZE | OF_NUMBER_TYPE_SIGNED, - /*! intmax_t */ + /*! `intmax_t` */ OF_NUMBER_TYPE_INTMAX = OF_NUMBER_TYPE_UINTMAX | OF_NUMBER_TYPE_SIGNED, - /*! ptrdiff_t */ + /*! `ptrdiff_t` */ OF_NUMBER_TYPE_PTRDIFF = 0x0E | OF_NUMBER_TYPE_SIGNED, - /*! intptr_t */ + /*! `intptr_t` */ OF_NUMBER_TYPE_INTPTR = 0x0F | OF_NUMBER_TYPE_SIGNED, - /*! float */ + /*! `float` */ OF_NUMBER_TYPE_FLOAT = 0x20, - /*! double */ + /*! `double` */ OF_NUMBER_TYPE_DOUBLE = 0x40 | OF_NUMBER_TYPE_FLOAT } of_number_type_t; /*! * @class OFNumber OFNumber.h ObjFW/OFNumber.h @@ -150,613 +150,623 @@ } _value; of_number_type_t _type; } /*! - * The type of the number. + * @brief The type of the number. */ @property (readonly, nonatomic) of_number_type_t type; /*! - * Returns the OFNumber as a bool. + * @brief The OFNumber as a `bool`. */ @property (readonly, nonatomic) bool boolValue; /*! - * The OFNumber as a signed char. + * @brief The OFNumber as a `signed char`. */ @property (readonly, nonatomic) signed char charValue; /*! - * The OFNumber as a signed short. + * @brief The OFNumber as a `signed short`. */ @property (readonly, nonatomic) signed short shortValue; /*! - * The OFNumber as a signed int. + * @brief The OFNumber as a `signed int`. */ @property (readonly, nonatomic) signed int intValue; /*! - * The OFNumber as a signed long. + * @brief The OFNumber as a `signed long`. */ @property (readonly, nonatomic) signed long longValue; /*! - * The OFNumber as a signed long long. + * @brief The OFNumber as a `signed long long`. */ @property (readonly, nonatomic) signed long long longLongValue; /*! - * The OFNumber as an unsigned char. + * @brief The OFNumber as an `unsigned char`. */ @property (readonly, nonatomic) unsigned char unsignedCharValue; /*! - * The OFNumber as an unsigned short. + * @brief The OFNumber as an `unsigned short`. */ @property (readonly, nonatomic) unsigned short unsignedShortValue; /*! - * The OFNumber as an unsigned int. + * @brief The OFNumber as an `unsigned int`. */ @property (readonly, nonatomic) unsigned int unsignedIntValue; /*! - * The OFNumber as an unsigned long. + * @brief The OFNumber as an `unsigned long`. */ @property (readonly, nonatomic) unsigned long unsignedLongValue; /*! - * The OFNumber as an unsigned long long. + * @brief The OFNumber as an `unsigned long long`. */ @property (readonly, nonatomic) unsigned long long unsignedLongLongValue; /*! - * The OFNumber as an int8_t. + * @brief The OFNumber as an `int8_t`. */ @property (readonly, nonatomic) int8_t int8Value; /*! - * The OFNumber as an int16_t. + * @brief The OFNumber as an `int16_t`. */ @property (readonly, nonatomic) int16_t int16Value; /*! - * The OFNumber as an int32_t. + * @brief The OFNumber as an `int32_t`. */ @property (readonly, nonatomic) int32_t int32Value; /*! - * The OFNumber as an int64_t. + * @brief The OFNumber as an `int64_t`. */ @property (readonly, nonatomic) int64_t int64Value; /*! - * The OFNumber as a uint8_t. + * @brief The OFNumber as a `uint8_t`. */ @property (readonly, nonatomic) uint8_t uInt8Value; /*! - * The OFNumber as a uint16_t. + * @brief The OFNumber as a `uint16_t`. */ @property (readonly, nonatomic) uint16_t uInt16Value; /*! - * The OFNumber as a uint32_t. + * @brief The OFNumber as a `uint32_t`. */ @property (readonly, nonatomic) uint32_t uInt32Value; /*! - * The OFNumber as a uint64_t. + * @brief The OFNumber as a `uint64_t`. */ @property (readonly, nonatomic) uint64_t uInt64Value; /*! - * The OFNumber as a size_t. + * @brief The OFNumber as a `size_t`. */ @property (readonly, nonatomic) size_t sizeValue; /*! - * The OFNumber as an ssize_t. + * @brief The OFNumber as an `ssize_t`. */ @property (readonly, nonatomic) ssize_t sSizeValue; /*! - * The OFNumber as an intmax_t. + * @brief The OFNumber as an `intmax_t`. */ @property (readonly, nonatomic) intmax_t intMaxValue; /*! - * The OFNumber as a uintmax_t. + * @brief The OFNumber as a `uintmax_t`. */ @property (readonly, nonatomic) uintmax_t uIntMaxValue; /*! - * The OFNumber as a ptrdiff_t. + * @brief The OFNumber as a `ptrdiff_t`. */ @property (readonly, nonatomic) ptrdiff_t ptrDiffValue; /*! - * The OFNumber as an intptr_t. + * @brief The OFNumber as an `intptr_t`. */ @property (readonly, nonatomic) intptr_t intPtrValue; /*! - * The OFNumber as a uintptr_t. + * @brief The OFNumber as a `uintptr_t`. */ @property (readonly, nonatomic) uintptr_t uIntPtrValue; /*! - * The OFNumber as a float. + * @brief The OFNumber as a `float`. */ @property (readonly, nonatomic) float floatValue; /*! - * The OFNumber as a double. + * @brief The OFNumber as a `double`. */ @property (readonly, nonatomic) double doubleValue; /*! - * @brief Creates a new OFNumber with the specified bool. + * @brief Creates a new OFNumber with the specified `bool`. * - * @param bool_ A bool which the OFNumber should contain + * @param bool_ A `bool` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithBool: (bool)bool_; /*! - * @brief Creates a new OFNumber with the specified signed char. + * @brief Creates a new OFNumber with the specified `signed char`. * - * @param sChar A signed char which the OFNumber should contain + * @param sChar A `signed char` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithChar: (signed char)sChar; /*! - * @brief Creates a new OFNumber with the specified signed short. + * @brief Creates a new OFNumber with the specified `signed short`. * - * @param sShort A signed short which the OFNumber should contain + * @param sShort A `signed short` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithShort: (signed short)sShort; /*! - * @brief Creates a new OFNumber with the specified signed int. + * @brief Creates a new OFNumber with the specified `signed int`. * - * @param sInt A signed int which the OFNumber should contain + * @param sInt A `signed int` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithInt: (signed int)sInt; /*! - * @brief Creates a new OFNumber with the specified signed long. + * @brief Creates a new OFNumber with the specified `signed long`. * - * @param sLong A signed long which the OFNumber should contain + * @param sLong A `signed long` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithLong: (signed long)sLong; /*! - * @brief Creates a new OFNumber with the specified signed long long. + * @brief Creates a new OFNumber with the specified `signed long long`. * - * @param sLongLong A signed long long which the OFNumber should contain + * @param sLongLong A `signed long long` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithLongLong: (signed long long)sLongLong; /*! - * @brief Creates a new OFNumber with the specified unsigned char. + * @brief Creates a new OFNumber with the specified `unsigned char`. * - * @param uChar An unsigned char which the OFNumber should contain + * @param uChar An `unsigned char` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithUnsignedChar: (unsigned char)uChar; /*! - * @brief Creates a new OFNumber with the specified unsigned short. + * @brief Creates a new OFNumber with the specified `unsigned short`. * - * @param uShort An unsigned short which the OFNumber should contain + * @param uShort An `unsigned short` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithUnsignedShort: (unsigned short)uShort; /*! - * @brief Creates a new OFNumber with the specified unsigned int. + * @brief Creates a new OFNumber with the specified `unsigned int`. * - * @param uInt An unsigned int which the OFNumber should contain + * @param uInt An `unsigned int` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithUnsignedInt: (unsigned int)uInt; /*! - * @brief Creates a new OFNumber with the specified unsigned long. + * @brief Creates a new OFNumber with the specified `unsigned long`. * - * @param uLong An unsigned long which the OFNumber should contain + * @param uLong An `unsigned long` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithUnsignedLong: (unsigned long)uLong; /*! - * @brief Creates a new OFNumber with the specified unsigned long long. + * @brief Creates a new OFNumber with the specified `unsigned long long`. * - * @param uLongLong An unsigned long long which the OFNumber should contain + * @param uLongLong An `unsigned long long` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithUnsignedLongLong: (unsigned long long)uLongLong; /*! - * @brief Creates a new OFNumber with the specified int8_t. + * @brief Creates a new OFNumber with the specified `int8_t`. * - * @param int8 An int8_t which the OFNumber should contain + * @param int8 An `int8_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithInt8: (int8_t)int8; /*! - * @brief Creates a new OFNumber with the specified int16_t. + * @brief Creates a new OFNumber with the specified `int16_t`. * - * @param int16 An int16_t which the OFNumber should contain + * @param int16 An `int16_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithInt16: (int16_t)int16; /*! - * @brief Creates a new OFNumber with the specified int32_t. + * @brief Creates a new OFNumber with the specified `int32_t`. * - * @param int32 An int32_t which the OFNumber should contain + * @param int32 An `int32_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithInt32: (int32_t)int32; /*! - * @brief Creates a new OFNumber with the specified int64_t. + * @brief Creates a new OFNumber with the specified `int64_t`. * - * @param int64 An int64_t which the OFNumber should contain + * @param int64 An `int64_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithInt64: (int64_t)int64; /*! - * @brief Creates a new OFNumber with the specified uint8_t. + * @brief Creates a new OFNumber with the specified `uint8_t`. * - * @param uInt8 A uint8_t which the OFNumber should contain + * @param uInt8 A `uint8_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithUInt8: (uint8_t)uInt8; /*! - * @brief Creates a new OFNumber with the specified uint16_t. + * @brief Creates a new OFNumber with the specified `uint16_t`. * - * @param uInt16 A uint16_t which the OFNumber should contain + * @param uInt16 A `uint16_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithUInt16: (uint16_t)uInt16; /*! - * @brief Creates a new OFNumber with the specified uint32_t. + * @brief Creates a new OFNumber with the specified `uint32_t`. * - * @param uInt32 A uint32_t which the OFNumber should contain + * @param uInt32 A `uint32_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithUInt32: (uint32_t)uInt32; /*! - * @brief Creates a new OFNumber with the specified uint64_t. + * @brief Creates a new OFNumber with the specified `uint64_t`. * - * @param uInt64 A uint64_t which the OFNumber should contain + * @param uInt64 A `uint64_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithUInt64: (uint64_t)uInt64; /*! - * @brief Creates a new OFNumber with the specified size_t. + * @brief Creates a new OFNumber with the specified `size_t`. * - * @param size A size_t which the OFNumber should contain + * @param size A `size_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithSize: (size_t)size; /*! - * @brief Creates a new OFNumber with the specified ssize_t. + * @brief Creates a new OFNumber with the specified `ssize_t`. * - * @param sSize An ssize_t which the OFNumber should contain + * @param sSize An `ssize_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithSSize: (ssize_t)sSize; /*! - * @brief Creates a new OFNumber with the specified intmax_t. + * @brief Creates a new OFNumber with the specified `intmax_t`. * - * @param intMax An intmax_t which the OFNumber should contain + * @param intMax An `intmax_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithIntMax: (intmax_t)intMax; /*! - * @brief Creates a new OFNumber with the specified uintmax_t. + * @brief Creates a new OFNumber with the specified `uintmax_t`. * - * @param uIntMax A uintmax_t which the OFNumber should contain + * @param uIntMax A `uintmax_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithUIntMax: (uintmax_t)uIntMax; /*! - * @brief Creates a new OFNumber with the specified ptrdiff_t. + * @brief Creates a new OFNumber with the specified `ptrdiff_t`. * - * @param ptrDiff A ptrdiff_t which the OFNumber should contain + * @param ptrDiff A `ptrdiff_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithPtrDiff: (ptrdiff_t)ptrDiff; /*! - * @brief Creates a new OFNumber with the specified intptr_t. + * @brief Creates a new OFNumber with the specified `intptr_t`. * - * @param intPtr An intptr_t which the OFNumber should contain + * @param intPtr An `intptr_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithIntPtr: (intptr_t)intPtr; /*! - * @brief Creates a new OFNumber with the specified uintptr_t. + * @brief Creates a new OFNumber with the specified `uintptr_t`. * - * @param uIntPtr A uintptr_t which the OFNumber should contain + * @param uIntPtr A `uintptr_t` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithUIntPtr: (uintptr_t)uIntPtr; /*! - * @brief Creates a new OFNumber with the specified float. + * @brief Creates a new OFNumber with the specified `float`. * - * @param float_ A float which the OFNumber should contain + * @param float_ A `float` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithFloat: (float)float_; /*! - * @brief Creates a new OFNumber with the specified double. + * @brief Creates a new OFNumber with the specified `double`. * - * @param double_ A double which the OFNumber should contain + * @param double_ A `double` which the OFNumber should contain * @return A new autoreleased OFNumber */ + (instancetype)numberWithDouble: (double)double_; - (instancetype)init OF_UNAVAILABLE; /*! - * @brief Initializes an already allocated OFNumber with the specified bool. + * @brief Initializes an already allocated OFNumber with the specified `bool`. * - * @param bool_ A bool which the OFNumber should contain + * @param bool_ A `bool` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithBool: (bool)bool_; /*! - * @brief Initializes an already allocated OFNumber with the specified signed - * char. + * @brief Initializes an already allocated OFNumber with the specified + * `signed char`. * - * @param sChar A signed char which the OFNumber should contain + * @param sChar A `signed char` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithChar: (signed char)sChar; /*! - * @brief Initializes an already allocated OFNumber with the specified signed - * short. + * @brief Initializes an already allocated OFNumber with the specified + * `signed short`. * - * @param sShort A signed short which the OFNumber should contain + * @param sShort A `signed short` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithShort: (signed short)sShort; /*! - * @brief Initializes an already allocated OFNumber with the specified signed - * int. + * @brief Initializes an already allocated OFNumber with the specified + * `signed int`. * - * @param sInt A signed int which the OFNumber should contain + * @param sInt A `signed int` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithInt: (signed int)sInt; /*! - * @brief Initializes an already allocated OFNumber with the specified signed - * long. + * @brief Initializes an already allocated OFNumber with the specified + * `signed long`. * - * @param sLong A signed long which the OFNumber should contain + * @param sLong A `signed long` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithLong: (signed long)sLong; /*! - * @brief Initializes an already allocated OFNumber with the specified signed - * long long. + * @brief Initializes an already allocated OFNumber with the specified + * `signed long long`. * - * @param sLongLong A signed long long which the OFNumber should contain + * @param sLongLong A `signed long long` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithLongLong: (signed long long)sLongLong; /*! - * @brief Initializes an already allocated OFNumber with the specified unsigned - * char. + * @brief Initializes an already allocated OFNumber with the specified + * `unsigned char`. * - * @param uChar An unsigned char which the OFNumber should contain + * @param uChar An `unsigned char` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithUnsignedChar: (unsigned char)uChar; /*! - * @brief Initializes an already allocated OFNumber with the specified unsigned - * short. + * @brief Initializes an already allocated OFNumber with the specified + * `unsigned short`. * - * @param uShort An unsigned short which the OFNumber should contain + * @param uShort An `unsigned short` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithUnsignedShort: (unsigned short)uShort; /*! - * @brief Initializes an already allocated OFNumber with the specified unsigned - * int. + * @brief Initializes an already allocated OFNumber with the specified + * `unsigned int`. * - * @param uInt An unsigned int which the OFNumber should contain + * @param uInt An `unsigned int` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithUnsignedInt: (unsigned int)uInt; /*! - * @brief Initializes an already allocated OFNumber with the specified unsigned - * long. + * @brief Initializes an already allocated OFNumber with the specified + * `unsigned long`. * - * @param uLong An unsigned long which the OFNumber should contain + * @param uLong An `unsigned long` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithUnsignedLong: (unsigned long)uLong; /*! - * @brief Initializes an already allocated OFNumber with the specified unsigned - * long long. + * @brief Initializes an already allocated OFNumber with the specified + * `unsigned long long`. * - * @param uLongLong An unsigned long long which the OFNumber should contain + * @param uLongLong An `unsigned long long` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithUnsignedLongLong: (unsigned long long)uLongLong; /*! - * @brief Initializes an already allocated OFNumber with the specified int8_t. + * @brief Initializes an already allocated OFNumber with the specified `int8_t`. * - * @param int8 An int8_t which the OFNumber should contain + * @param int8 An `int8_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithInt8: (int8_t)int8; /*! - * @brief Initializes an already allocated OFNumber with the specified int16_t. + * @brief Initializes an already allocated OFNumber with the specified + * `int16_t`. * - * @param int16 An int16_t which the OFNumber should contain + * @param int16 An `int16_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithInt16: (int16_t)int16; /*! - * @brief Initializes an already allocated OFNumber with the specified int32_t. + * @brief Initializes an already allocated OFNumber with the specified + * `int32_t`. * - * @param int32 An int32_t which the OFNumber should contain + * @param int32 An `int32_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithInt32: (int32_t)int32; /*! - * @brief Initializes an already allocated OFNumber with the specified int64_t. + * @brief Initializes an already allocated OFNumber with the specified + * `int64_t`. * - * @param int64 An int64_t which the OFNumber should contain + * @param int64 An `int64_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithInt64: (int64_t)int64; /*! - * @brief Initializes an already allocated OFNumber with the specified uint8_t. + * @brief Initializes an already allocated OFNumber with the specified + * `uint8_t`. * - * @param uInt8 A uint8_t which the OFNumber should contain + * @param uInt8 A `uint8_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithUInt8: (uint8_t)uInt8; /*! - * @brief Initializes an already allocated OFNumber with the specified uint16_t. + * @brief Initializes an already allocated OFNumber with the specified + * `uint16_t`. * - * @param uInt16 A uint16_t which the OFNumber should contain + * @param uInt16 A `uint16_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithUInt16: (uint16_t)uInt16; /*! - * @brief Initializes an already allocated OFNumber with the specified uint32_t. + * @brief Initializes an already allocated OFNumber with the specified + * `uint32_t`. * - * @param uInt32 A uint32_t which the OFNumber should contain + * @param uInt32 A `uint32_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithUInt32: (uint32_t)uInt32; /*! - * @brief Initializes an already allocated OFNumber with the specified uint64_t. + * @brief Initializes an already allocated OFNumber with the specified + * `uint64_t`. * - * @param uInt64 A uint64_t which the OFNumber should contain + * @param uInt64 A `uint64_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithUInt64: (uint64_t)uInt64; /*! - * @brief Initializes an already allocated OFNumber with the specified size_t. + * @brief Initializes an already allocated OFNumber with the specified `size_t`. * - * @param size A size_t which the OFNumber should contain + * @param size A `size_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithSize: (size_t)size; /*! - * @brief Initializes an already allocated OFNumber with the specified ssize_t. + * @brief Initializes an already allocated OFNumber with the specified + * `ssize_t`. * - * @param sSize An ssize_t which the OFNumber should contain + * @param sSize An `ssize_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithSSize: (ssize_t)sSize; /*! - * @brief Initializes an already allocated OFNumber with the specified intmax_t. + * @brief Initializes an already allocated OFNumber with the specified + * `intmax_t`. * - * @param intMax An intmax_t which the OFNumber should contain + * @param intMax An `intmax_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithIntMax: (intmax_t)intMax; /*! * @brief Initializes an already allocated OFNumber with the specified - * uintmax_t. + * `uintmax_t`. * - * @param uIntMax A uintmax_t which the OFNumber should contain + * @param uIntMax A `uintmax_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithUIntMax: (uintmax_t)uIntMax; /*! * @brief Initializes an already allocated OFNumber with the specified - * ptrdiff_t. + * `ptrdiff_t`. * - * @param ptrDiff A ptrdiff_t which the OFNumber should contain + * @param ptrDiff A `ptrdiff_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithPtrDiff: (ptrdiff_t)ptrDiff; /*! - * @brief Initializes an already allocated OFNumber with the specified intptr_t. + * @brief Initializes an already allocated OFNumber with the specified + * `intptr_t`. * - * @param intPtr An intptr_t which the OFNumber should contain + * @param intPtr An `intptr_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithIntPtr: (intptr_t)intPtr; /*! * @brief Initializes an already allocated OFNumber with the specified - * uintptr_t. + * `uintptr_t`. * - * @param uIntPtr A uintptr_t which the OFNumber should contain + * @param uIntPtr A `uintptr_t` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithUIntPtr: (uintptr_t)uIntPtr; /*! - * @brief Initializes an already allocated OFNumber with the specified float. + * @brief Initializes an already allocated OFNumber with the specified `float`. * - * @param float_ A float which the OFNumber should contain + * @param float_ A `float` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithFloat: (float)float_; /*! - * @brief Initializes an already allocated OFNumber with the specified double. + * @brief Initializes an already allocated OFNumber with the specified `double`. * - * @param double_ A double which the OFNumber should contain + * @param double_ A `double` which the OFNumber should contain * @return An initialized OFNumber */ - (instancetype)initWithDouble: (double)double_; @end Index: src/OFObject+Serialization.h ================================================================== --- src/OFObject+Serialization.h +++ src/OFObject+Serialization.h @@ -28,11 +28,11 @@ } #endif @interface OFObject (OFSerialization) /*! - * The object serialized as a string. + * @brief The object serialized as a string. */ @property (readonly, nonatomic) OFString *stringBySerializing; @end OF_ASSUME_NONNULL_END Index: src/OFObject.h ================================================================== --- src/OFObject.h +++ src/OFObject.h @@ -197,21 +197,21 @@ * * @brief The protocol which all root classes implement. */ @protocol OFObject /*! - * The class of the object. + * @brief The class of the object. */ @property (readonly, nonatomic) Class class; /*! - * The superclass of the object. + * @brief The superclass of the object. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) Class superclass; /*! - * A 32 bit hash for the object. + * @brief A 32 bit hash for the object. * * Classes containing data (like strings, arrays, lists etc.) should reimplement * this! * * @warning If you reimplement this, you also need to reimplement @ref isEqual: @@ -219,21 +219,21 @@ * method! */ @property (readonly, nonatomic) uint32_t hash; /*! - * The retain count. + * @brief The retain count. */ @property (readonly, nonatomic) unsigned int retainCount; /*! - * Whether the object is a proxy object. + * @brief Whether the object is a proxy object. */ @property (readonly, nonatomic) bool isProxy; /*! - * Whether the object allows weak references. + * @brief Whether the object allows weak references. */ @property (readonly, nonatomic) bool allowsWeakReference; /*! * @brief Returns a boolean whether the object of the specified kind. @@ -422,16 +422,16 @@ @property (class, readonly, nullable, nonatomic) Class superclass; @property (class, readonly, nonatomic) OFString *description; #endif /*! - * The name of the object's class. + * @brief The name of the object's class. */ @property (readonly, nonatomic) OFString *className; /*! - * A description for the object. + * @brief A description for the object. * * This is used when the object is used in a format string and for debugging * purposes. */ @property (readonly, nonatomic) OFString *description; Index: src/OFOptionsParser.h ================================================================== --- src/OFOptionsParser.h +++ src/OFOptionsParser.h @@ -75,22 +75,22 @@ OFString *_Nullable _lastLongOption, *_Nullable _argument; bool _done; } /*! - * The last parsed option. + * @brief The last parsed option. * * If @ref nextOption returned `?` or `:`, this returns the option which was * unknown or for which the argument was missing.@n * If this returns `-`, the last option is only available as a long option (see * lastLongOption). */ @property (readonly, nonatomic) of_unichar_t lastOption; /*! - * The long option for the last parsed option, or `nil` if the last parsed - * option was not passed as a long option by the user. + * @brief The long option for the last parsed option, or `nil` if the last + * parsed option was not passed as a long option by the user. * * In case @ref nextOption returned `?`, this contains the unknown long * option.@n * In case it returned `:`, this contains the long option which is missing an * argument.@n @@ -102,17 +102,17 @@ * it was actually specified as a long option by the user. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *lastLongOption; /*! - * The argument for the last parsed option, or `nil` if the last parsed option - * takes no argument. + * @brief The argument for the last parsed option, or `nil` if the last parsed + * option takes no argument. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *argument; /*! - * The arguments following the last option. + * @brief The arguments following the last option. */ @property (readonly, nonatomic) OFArray OF_GENERIC(OFString *) *remainingArguments; /*! Index: src/OFPair.h ================================================================== --- src/OFPair.h +++ src/OFPair.h @@ -33,17 +33,17 @@ FirstType _Nullable _firstObject; SecondType _Nullable _secondObject; } /*! - * The first object of the pair. + * @brief The first object of the pair. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic, retain) FirstType firstObject; /*! - * The second object of the pair. + * @brief The second object of the pair. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic, retain) SecondType secondObject; /*! Index: src/OFSandbox.h ================================================================== --- src/OFSandbox.h +++ src/OFSandbox.h @@ -55,92 +55,148 @@ unsigned int _allowsPF: 1; unsigned int _allowsAudio: 1; unsigned int _allowsBPF: 1; } -/*! Allows IO operations on previously allocated file descriptors. */ +/*! + * @brief Allows IO operations on previously allocated file descriptors. + */ @property (nonatomic) bool allowsStdIO; -/*! Allows read access to the file system. */ +/*! + * @brief Allows read access to the file system. + */ @property (nonatomic) bool allowsReadingFiles; -/*! Allows write access to the file system. */ +/*! + * @brief Allows write access to the file system. + */ @property (nonatomic) bool allowsWritingFiles; -/*! Allows creating files in the file system. */ +/*! + * @brief Allows creating files in the file system. + */ @property (nonatomic) bool allowsCreatingFiles; -/*! Allows creating special files in the file system. */ +/*! + * @brief Allows creating special files in the file system. + */ @property (nonatomic) bool allowsCreatingSpecialFiles; -/*! Allows creating, reading and writing temporary files in /tmp. */ +/*! + * @brief Allows creating, reading and writing temporary files in `/tmp`. + */ @property (nonatomic) bool allowsTemporaryFiles; -/*! Allows using IP sockets. */ +/*! + * @brief Allows using IP sockets. + */ @property (nonatomic) bool allowsIPSockets; -/*! Allows multicast sockets. */ +/*! + * @brief Allows multicast sockets. + */ @property (nonatomic) bool allowsMulticastSockets; -/*! Allows explicit changes to file attributes. */ +/*! + * @brief Allows explicit changes to file attributes. + */ @property (nonatomic) bool allowsChangingFileAttributes; -/*! Allows changing ownership of files. */ +/*! + * @brief Allows changing ownership of files. + */ @property (nonatomic) bool allowsFileOwnerChanges; -/*! Allows file locks. */ +/*! + * @brief Allows file locks. + */ @property (nonatomic) bool allowsFileLocks; -/*! Allows UNIX sockets. */ +/*! + * @brief Allows UNIX sockets. + */ @property (nonatomic) bool allowsUNIXSockets; -/*! Allows syscalls necessary for DNS lookups. */ +/*! + * @brief Allows syscalls necessary for DNS lookups. + */ @property (nonatomic) bool allowsDNS; -/*! Allows to look up users and groups. */ +/*! + * @brief Allows to look up users and groups. + */ @property (nonatomic) bool allowsUserDatabaseReading; -/*! Allows sending file descriptors via sendmsg(). */ +/*! + * @brief Allows sending file descriptors via sendmsg(). + */ @property (nonatomic) bool allowsFileDescriptorSending; -/*! Allows receiving file descriptors via recvmsg(). */ +/*! + * @brief Allows receiving file descriptors via recvmsg(). + */ @property (nonatomic) bool allowsFileDescriptorReceiving; -/*! Allows MTIOCGET and MTIOCTOP operations on tape devices. */ +/*! + * @brief Allows MTIOCGET and MTIOCTOP operations on tape devices. + */ @property (nonatomic) bool allowsTape; -/*! Allows read-write operations and ioctls on the TTY. */ +/*! + * @brief Allows read-write operations and ioctls on the TTY. + */ @property (nonatomic) bool allowsTTY; -/*! Allows various process relationshop operations. */ +/*! + * @brief Allows various process relationshop operations. + */ @property (nonatomic) bool allowsProcessOperations; -/*! Allows execve(). */ +/*! + * @brief Allows execve(). + */ @property (nonatomic) bool allowsExec; -/*! Allows PROT_EXEC for mmap() and mprotect(). */ +/*! + * @brief Allows PROT_EXEC for `mmap()` and `mprotect()`. + */ @property (nonatomic) bool allowsProtExec; -/*! Allows settime(). */ +/*! + * @brief Allows `settime()`. + */ @property (nonatomic) bool allowsSetTime; -/*! Allows introspection of processes on the system. */ +/*! + * @brief Allows introspection of processes on the system. + */ @property (nonatomic) bool allowsPS; -/*! Allows introspection of the system's virtual memory. */ +/*! + * @brief Allows introspection of the system's virtual memory. + */ @property (nonatomic) bool allowsVMInfo; -/*! Allows changing the rights of process, for example the UID. */ +/*! + * @brief Allows changing the rights of process, for example the UID. + */ @property (nonatomic) bool allowsChangingProcessRights; -/*! Allows certain ioctls on the PF device. */ +/*! + * @brief Allows certain ioctls on the PF device. + */ @property (nonatomic) bool allowsPF; -/*! Allows certain ioctls on audio devices. */ +/*! + * @brief Allows certain ioctls on audio devices. + */ @property (nonatomic) bool allowsAudio; -/*! Allows BIOCGSTATS to collect statistics from a BPF device. */ +/*! + * @brief Allows BIOCGSTATS to collect statistics from a BPF device. + */ @property (nonatomic) bool allowsBPF; /*! * @brief Create a new, autorelease OFSandbox. */ Index: src/OFSerialization.h ================================================================== --- src/OFSerialization.h +++ src/OFSerialization.h @@ -27,11 +27,11 @@ * * @brief A protocol for serializing objects. */ @protocol OFSerialization /*! - * The object serialized into an XML element. + * @brief The object serialized into an XML element. */ @property (readonly, nonatomic) OFXMLElement *XMLElementBySerializing; /*! * @brief Initializes the object with the specified XML element serialization. Index: src/OFSet.h ================================================================== --- src/OFSet.h +++ src/OFSet.h @@ -64,16 +64,16 @@ OFMutableCopying, OFSerialization> #if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN) # define ObjectType id #endif /*! - * An array of all objects in the set. + * @brief An array of all objects in the set. */ @property (readonly, nonatomic) OFArray OF_GENERIC(ObjectType) *allObjects; /*! - * @return An arbitrary object in the set. + * @brief An arbitrary object in the set. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) ObjectType anyObject; /*! * @brief Creates a new set. Index: src/OFSettings.h ================================================================== --- src/OFSettings.h +++ src/OFSettings.h @@ -36,11 +36,12 @@ { OFString *_applicationName; } /*! - * The name of the application whose settings are accessed by the instance. + * @brief The name of the application whose settings are accessed by the + * instance. */ @property (readonly, nonatomic) OFString *applicationName; /*! * @brief Create a new OFSettings instance for the application with the Index: src/OFStdIOStream.h ================================================================== --- src/OFStdIOStream.h +++ src/OFStdIOStream.h @@ -45,18 +45,18 @@ #endif bool _atEndOfStream; } /*! - * The number of columns, or -1 if there is no underlying terminal or the - * number of columns could not be queried. + * @brief The number of columns, or -1 if there is no underlying terminal or + * the number of columns could not be queried. */ @property (readonly, nonatomic) int columns; /*! - * The number of rows, or -1 if there is no underlying terminal or the number - * of rows could not be queried + * @brief The number of rows, or -1 if there is no underlying terminal or the + * number of rows could not be queried. */ @property (readonly, nonatomic) int rows; - (instancetype)init OF_UNAVAILABLE; @end Index: src/OFStream.h ================================================================== --- src/OFStream.h +++ src/OFStream.h @@ -120,39 +120,39 @@ @protected bool _blocking; } /*! - * Whether the end of the stream has been reached. + * @brief Whether the end of the stream has been reached. */ @property (readonly, nonatomic, getter=isAtEndOfStream) bool atEndOfStream; /*! - * Whether writes are buffered. + * @brief Whether writes are buffered. */ @property (nonatomic, nonatomic, getter=isWriteBuffered) bool writeBuffered; /*! - * Whether data is present in the internal read buffer. + * @brief Whether data is present in the internal read buffer. */ @property (readonly, nonatomic) bool hasDataInReadBuffer; /*! - * Whether the stream is in blocking mode. + * @brief Whether the stream is in blocking mode. * * By default, a stream is in blocking mode. * On Win32, setting this currently only works for sockets! */ @property (readonly, nonatomic, getter=isBlocking) bool blocking; /*! - * The file descriptor for the read end of the stream. + * @brief The file descriptor for the read end of the stream. */ @property (readonly, nonatomic) int fileDescriptorForReading; /*! - * The file descriptor for the write end of the stream. + * @brief The file descriptor for the write end of the stream. */ @property (readonly, nonatomic) int fileDescriptorForWriting; /*! * @brief Reads *at most* size bytes from the stream into a buffer. Index: src/OFString+CryptoHashing.h ================================================================== --- src/OFString+CryptoHashing.h +++ src/OFString+CryptoHashing.h @@ -26,41 +26,41 @@ } #endif @interface OFString (CryptoHashing) /*! - * The MD5 hash of the string as a string. + * @brief The MD5 hash of the string as a string. */ @property (readonly, nonatomic) OFString *MD5Hash; /*! - * The RIPEMD-160 hash of the string as a string. + * @brief The RIPEMD-160 hash of the string as a string. */ @property (readonly, nonatomic) OFString *RIPEMD160Hash; /*! - * The SHA-1 hash of the string as a string. + * @brief The SHA-1 hash of the string as a string. */ @property (readonly, nonatomic) OFString *SHA1Hash; /*! - * The SHA-224 hash of the string as a string. + * @brief The SHA-224 hash of the string as a string. */ @property (readonly, nonatomic) OFString *SHA224Hash; /*! - * The SHA-256 hash of the string as a string. + * @brief The SHA-256 hash of the string as a string. */ @property (readonly, nonatomic) OFString *SHA256Hash; /*! - * The SHA-384 hash of the string as a string. + * @brief The SHA-384 hash of the string as a string. */ @property (readonly, nonatomic) OFString *SHA384Hash; /*! - * The SHA-512 hash of the string as a string. + * @brief The SHA-512 hash of the string as a string. */ @property (readonly, nonatomic) OFString *SHA512Hash; @end OF_ASSUME_NONNULL_END Index: src/OFString+JSONValue.h ================================================================== --- src/OFString+JSONValue.h +++ src/OFString+JSONValue.h @@ -26,11 +26,11 @@ } #endif @interface OFString (JSONValue) /*! - * The string interpreted as JSON and parsed as an object. + * @brief The string interpreted as JSON and parsed as an object. * * @note This also allows parsing JSON5, an extension of JSON. See * http://json5.org/ for more details. * * @warning Although not specified by the JSON specification, this can also Index: src/OFString+Serialization.h ================================================================== --- src/OFString+Serialization.h +++ src/OFString+Serialization.h @@ -26,11 +26,11 @@ } #endif @interface OFString (Serialization) /*! - * The string interpreted as serialization and parsed as an object. + * @brief The string interpreted as serialization and parsed as an object. */ @property (readonly, nonatomic) id objectByDeserializing; @end OF_ASSUME_NONNULL_END Index: src/OFString+URLEncoding.h ================================================================== --- src/OFString+URLEncoding.h +++ src/OFString+URLEncoding.h @@ -28,11 +28,11 @@ } #endif @interface OFString (URLEncoding) /*! - * The string as an URL decoded string. + * @brief The string as an URL decoded string. */ @property (readonly, nonatomic) OFString *stringByURLDecoding; /*! * @brief Encodes a string for use in a URL, but does not escape the specified Index: src/OFString+XMLEscaping.h ================================================================== --- src/OFString+XMLEscaping.h +++ src/OFString+XMLEscaping.h @@ -26,11 +26,11 @@ } #endif @interface OFString (XMLEscaping) /*! - * The string in a form escaped for use in an XML document. + * @brief The string in a form escaped for use in an XML document. */ @property (readonly, nonatomic) OFString *stringByXMLEscaping; @end OF_ASSUME_NONNULL_END Index: src/OFString+XMLUnescaping.h ================================================================== --- src/OFString+XMLUnescaping.h +++ src/OFString+XMLUnescaping.h @@ -64,11 +64,11 @@ containsUnknownEntityNamed: (OFString *)entity; @end @interface OFString (XMLUnescaping) /*! - * The string with XML entities unescapted. + * @brief The string with XML entities unescapted. */ @property (readonly, nonatomic) OFString *stringByXMLUnescaping; /*! * @brief Unescapes XML in the string and uses the specified delegate for Index: src/OFString.h ================================================================== --- src/OFString.h +++ src/OFString.h @@ -114,64 +114,64 @@ */ @interface OFString: OFObject /*! - * The length of the string in Unicode codepoints. + * @brief The length of the string in Unicode codepoints. */ @property (readonly, nonatomic) size_t length; /*! - * The OFString as a UTF-8 encoded C string. + * @brief The OFString as a UTF-8 encoded C string. * * The result is valid until the autorelease pool is released. If you want to * use the result outside the scope of the current autorelease pool, you have to * copy it. */ @property (readonly, nonatomic) const char *UTF8String OF_RETURNS_INNER_POINTER; /*! - * The number of bytes the string needs in UTF-8 encoding. + * @brief The number of bytes the string needs in UTF-8 encoding. */ @property (readonly, nonatomic) size_t UTF8StringLength; /*! - * The components of the string when interpreted as a path. + * @brief The components of the string when interpreted as a path. */ @property (readonly, nonatomic) OFArray OF_GENERIC(OFString *) *pathComponents; /*! - * The last path component of the string when interpreted as a path. + * @brief The last path component of the string when interpreted as a path. */ @property (readonly, nonatomic) OFString *lastPathComponent; /*! - * The file extension of string when interpreted as a path. + * @brief The file extension of string when interpreted as a path. */ @property (readonly, nonatomic) OFString *pathExtension; /*! - * The string in uppercase. + * @brief The string in uppercase. */ @property (readonly, nonatomic) OFString *uppercaseString; /*! - * The string in lowercase. + * @brief The string in lowercase. */ @property (readonly, nonatomic) OFString *lowercaseString; /*! - * The string in capitalized form. + * @brief The string in capitalized form. * * @note This only considers spaces, tabs and newlines to be word delimiters! * Also note that this might change in the future to all word delimiters * specified by Unicode! */ @property (readonly, nonatomic) OFString *capitalizedString; /*! - * The decimal value of the string as an `intmax_t`. + * @brief The decimal value of the string as an `intmax_t`. * * Leading and trailing whitespaces are ignored. * * If the string contains any non-number characters, an * @ref OFInvalidEncodingException is thrown. @@ -180,11 +180,11 @@ * @ref OFOutOfRangeException is thrown. */ @property (readonly, nonatomic) intmax_t decimalValue; /*! - * The hexadecimal value of the string as an `uintmax_t`. + * @brief The hexadecimal value of the string as an `uintmax_t`. * * Leading and trailing whitespaces are ignored. * * If the string contains any non-number characters, an * @ref OFInvalidEncodingException is thrown. @@ -193,11 +193,11 @@ * @ref OFOutOfRangeException is thrown. */ @property (readonly, nonatomic) uintmax_t hexadecimalValue; /*! - * The octal value of the string as an `uintmax_t`. + * @brief The octal value of the string as an `uintmax_t`. * * Leading and trailing whitespaces are ignored. * * If the string contains any non-number characters, an * @ref OFInvalidEncodingException is thrown. @@ -206,106 +206,106 @@ * @ref OFOutOfRangeException is thrown. */ @property (readonly, nonatomic) uintmax_t octalValue; /*! - * The float value of the string as a float. + * @brief The float value of the string as a float. * * If the string contains any non-number characters, an * @ref OFInvalidEncodingException is thrown. */ @property (readonly, nonatomic) float floatValue; /*! - * The double value of the string as a double. + * @brief The double value of the string as a double. * * If the string contains any non-number characters, an * OFInvalidEncodingException is thrown. */ @property (readonly, nonatomic) double doubleValue; /*! - * The directory name of the string when interpreted as a path. + * @brief The directory name of the string when interpreted as a path. */ @property (readonly, nonatomic) OFString *stringByDeletingLastPathComponent; /*! - * The string with the file extension of the path removed. + * @brief The string with the file extension of the path removed. */ @property (readonly, nonatomic) OFString *stringByDeletingPathExtension; /*! - * The string interpreted as a path with relative sub paths resolved. + * @brief The string interpreted as a path with relative sub paths resolved. */ @property (readonly, nonatomic) OFString *stringByStandardizingPath; /*! - * The string interpreted as a URL path with relative sub paths resolved. + * @brief The string interpreted as a URL path with relative sub paths resolved. * * This works similar to @ref stringByStandardizingPath, but is intended for * standardization of paths that are part of a URL. */ @property (readonly, nonatomic) OFString *stringByStandardizingURLPath; /*! - * The string as an array of Unicode characters. + * @brief The string as an array of Unicode characters. * * The result is valid until the autorelease pool is released. If you want to * use the result outside the scope of the current autorelease pool, you have to * copy it. */ @property (readonly, nonatomic) const of_unichar_t *characters OF_RETURNS_INNER_POINTER; /*! - * The string in UTF-16 encoding with native byte order. + * @brief The string in UTF-16 encoding with native byte order. * * The result is valid until the autorelease pool is released. If you want to * use the result outside the scope of the current autorelease pool, you have to * copy it. */ @property (readonly, nonatomic) const char16_t *UTF16String OF_RETURNS_INNER_POINTER; /*! - * The length of the string in UTF-16 characters. + * @brief The length of the string in UTF-16 characters. */ @property (readonly, nonatomic) size_t UTF16StringLength; /*! - * The string in UTF-32 encoding with native byte order. + * @brief The string in UTF-32 encoding with native byte order. * * The result is valid until the autorelease pool is released. If you want to * use the result outside the scope of the current autorelease pool, you have to * copy it. */ @property (readonly, nonatomic) const char32_t *UTF32String OF_RETURNS_INNER_POINTER; /*! - * The string with leading whitespaces deleted. + * @brief The string with leading whitespaces deleted. */ @property (readonly, nonatomic) OFString *stringByDeletingLeadingWhitespaces; /*! - * The string with trailing whitespaces deleted. + * @brief The string with trailing whitespaces deleted. */ @property (readonly, nonatomic) OFString *stringByDeletingTrailingWhitespaces; /*! - * The string with leading and trailing whitespaces deleted. + * @brief The string with leading and trailing whitespaces deleted. */ @property (readonly, nonatomic) OFString *stringByDeletingEnclosingWhitespaces; #ifdef OF_HAVE_UNICODE_TABLES /*! - * The string in Unicode Normalization Form D (NFD). + * @brief The string in Unicode Normalization Form D (NFD). */ @property (readonly, nonatomic) OFString *decomposedStringWithCanonicalMapping; /*! - * The string in Unicode Normalization Form KD (NFKD). + * @brief The string in Unicode Normalization Form KD (NFKD). */ @property (readonly, nonatomic) OFString *decomposedStringWithCompatibilityMapping; #endif Index: src/OFTCPSocket.h ================================================================== --- src/OFTCPSocket.h +++ src/OFTCPSocket.h @@ -74,46 +74,46 @@ @property (class, nullable, copy, nonatomic) OFString *SOCKS5Host; @property (class, nonatomic) uint16_t SOCKS5Port; #endif /*! - * Whether the socket is a listening socket. + * @brief Whether the socket is a listening socket. */ @property (readonly, nonatomic, getter=isListening) bool listening; /*! - * The remote address as a string + * @brief The remote address as a string * * @note This only works for accepted sockets! */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *remoteAddress; #if !defined(OF_WII) && !defined(OF_NINTENDO_3DS) /*! - * Whether keep alives are enabled for the connection. + * @brief Whether keep alives are enabled for the connection. * * @warning This is not available on the Wii or Nintendo 3DS! */ @property (nonatomic, getter=isKeepAliveEnabled) bool keepAliveEnabled; #endif #ifndef OF_WII /*! - * Whether TCP_NODELAY is enabled for the connection + * @brief Whether TCP_NODELAY is enabled for the connection * * @warning This is not available on the Wii! */ @property (nonatomic, getter=isTCPNoDelayEnabled) bool TCPNoDelayEnabled; #endif /*! - * The host to use as a SOCKS5 proxy. + * @brief The host to use as a SOCKS5 proxy. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *SOCKS5Host; /*! - * The port to use on the SOCKS5 proxy. + * @brief The port to use on the SOCKS5 proxy. */ @property (nonatomic) uint16_t SOCKS5Port; /*! * @brief Sets the global SOCKS5 proxy host to use when creating a new socket Index: src/OFTLSSocket.h ================================================================== --- src/OFTLSSocket.h +++ src/OFTLSSocket.h @@ -53,36 +53,36 @@ * @brief A protocol that should be implemented by 3rd-party libraries * implementing TLS. */ @protocol OFTLSSocket /*! - * The delegate for the TLS socket. + * @brief The delegate for the TLS socket. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) id delegate; /*! - * The path to the X.509 certificate file to use. + * @brief The path to the X.509 certificate file to use. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *certificateFile; /*! - * The path to the PKCS#8 private key file to use. + * @brief The path to the PKCS#8 private key file to use. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *privateKeyFile; /*! - * The passphrase to decrypt the PKCS#8 private key file. + * @brief The passphrase to decrypt the PKCS#8 private key file. * * @warning You have to ensure that this is in secure memory protected from * swapping! This is also the reason why this is not an OFString. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) const char *privateKeyPassphrase; /*! - * Whether certificate verification is enabled. + * @brief Whether certificate verification is enabled. * * The default is enabled. */ @property (nonatomic, getter=isCertificateVerificationEnabled) bool certificateVerificationEnabled; Index: src/OFTarArchive.h ================================================================== --- src/OFTarArchive.h +++ src/OFTarArchive.h @@ -37,11 +37,11 @@ } _mode; OF_KINDOF(OFStream *) _Nullable _lastReturnedStream; } /*! - * @return A stream for reading the current entry + * @brief A stream for reading the current entry * * @note This is only available in read mode. */ @property (readonly, nonatomic) OFStream *streamForReadingCurrentEntry; Index: src/OFTarArchiveEntry.h ================================================================== --- src/OFTarArchiveEntry.h +++ src/OFTarArchiveEntry.h @@ -61,69 +61,69 @@ OFString *_Nullable _owner, *_Nullable _group; uint32_t _deviceMajor, _deviceMinor; } /*! - * The file name of the entry. + * @brief The file name of the entry. */ @property (readonly, copy, nonatomic) OFString *fileName; /*! - * The mode of the entry. + * @brief The mode of the entry. */ @property (readonly, nonatomic) uint32_t mode; /*! - * The UID of the owner. + * @brief The UID of the owner. */ @property (readonly, nonatomic) uint32_t UID; /*! - * The GID of the group. + * @brief The GID of the group. */ @property (readonly, nonatomic) uint32_t GID; /*! - * The size of the file. + * @brief The size of the file. */ @property (readonly, nonatomic) uint64_t size; /*! - * The date of the last modification of the file. + * @brief The date of the last modification of the file. */ @property (readonly, retain, nonatomic) OFDate *modificationDate; /*! - * The type of the archive entry. + * @brief The type of the archive entry. * * See @ref of_tar_archive_entry_type_t. */ @property (readonly, nonatomic) of_tar_archive_entry_type_t type; /*! - * The file name of the target (for a hard link or symbolic link). + * @brief The file name of the target (for a hard link or symbolic link). */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *targetFileName; /*! - * The owner of the file. + * @brief The owner of the file. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *owner; /*! - * The group of the file. + * @brief The group of the file. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *group; /*! - * The device major (if the file is a device). + * @brief The device major (if the file is a device). */ @property (readonly, nonatomic) uint32_t deviceMajor; /*! - * The device major (if the file is a device). + * @brief The device major (if the file is a device). */ @property (readonly, nonatomic) uint32_t deviceMinor; /*! * @brief Creates a new OFTarArchiveEntry with the specified file name. Index: src/OFThread.h ================================================================== --- src/OFThread.h +++ src/OFThread.h @@ -84,11 +84,11 @@ OFMutableDictionary *threadDictionary; @property (class, nullable, copy, nonatomic) OFString *name; # endif /*! - * The name for the thread to use when starting it. + * @brief The name for the thread to use when starting it. * * @note While this can be changed after the thread has been started, it will * have no effect once the thread started. If you want to change the name * of the current thread after it has been started, look at the class * method @ref setName:. @@ -95,23 +95,23 @@ */ @property OF_NULLABLE_PROPERTY (copy) OFString *name; # ifdef OF_HAVE_BLOCKS /*! - * The block to execute in the thread. + * @brief The block to execute in the thread. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) of_thread_block_t threadBlock; # endif /*! - * The run loop for the thread. + * @brief The run loop for the thread. */ @property (readonly, nonatomic) OFRunLoop *runLoop; /*! - * The priority of the thread. + * @brief The priority of the thread. * * @note This has to be set before the thread is started! * * This is a value between -1.0 (meaning lowest priority that still schedules) * and +1.0 (meaning highest priority that still allows getting preempted) @@ -118,11 +118,11 @@ * with normal priority being 0.0 (meaning being the same as the main thread). */ @property (nonatomic) float priority; /*! - * The stack size of the thread. + * @brief The stack size of the thread. * * @note This has to be set before the thread is started! */ @property (nonatomic) size_t stackSize; Index: src/OFThreadPool.h ================================================================== --- src/OFThreadPool.h +++ src/OFThreadPool.h @@ -51,11 +51,11 @@ volatile int _doneCount; OFCondition *_countCondition; } /*! - * The size of the thread pool. + * @brief The size of the thread pool. */ @property (readonly, nonatomic) size_t size; /*! * @brief Returns a new thread pool with one thread for each core in the system. Index: src/OFTimer.h ================================================================== --- src/OFTimer.h +++ src/OFTimer.h @@ -60,27 +60,27 @@ #endif OFRunLoop *_Nullable _inRunLoop; } /*! - * The time interval in which the timer will repeat, if it is a repeating - * timer. + * @brief The time interval in which the timer will repeat, if it is a + * repeating timer. */ @property (readonly, nonatomic) of_time_interval_t timeInterval; /*! - * Whether the timer is repeating. + * @brief Whether the timer is repeating. */ @property (readonly, nonatomic, getter=isRepeating) bool repeating; /*! - * Whether the timer is valid. + * @brief Whether the timer is valid. */ @property (readonly, nonatomic, getter=isValid) bool valid; /*! - * The next date at which the timer will fire. + * @brief The next date at which the timer will fire. * * If the timer is already scheduled in a run loop, it will be rescheduled. * Note that rescheduling is an expensive operation, though it still might be * preferable to reschedule instead of invalidating the timer and creating a * new one. Index: src/OFTriple.h ================================================================== --- src/OFTriple.h +++ src/OFTriple.h @@ -35,23 +35,23 @@ SecondType _Nullable _secondObject; ThirdType _Nullable _thirdObject; } /*! - * The first object of the triple. + * @brief The first object of the triple. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic, retain) FirstType firstObject; /*! - * The second object of the triple. + * @brief The second object of the triple. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic, retain) SecondType secondObject; /*! - * The third object of the triple. + * @brief The third object of the triple. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic, retain) ThirdType thirdObject; /*! Index: src/OFURL.h ================================================================== --- src/OFURL.h +++ src/OFURL.h @@ -37,114 +37,114 @@ OFString *_Nullable _URLEncodedPath; OFString *_Nullable _URLEncodedQuery, *_Nullable _URLEncodedFragment; } /*! - * The scheme part of the URL. + * @brief The scheme part of the URL. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *scheme; /*! - * The scheme part of the URL in URL-encoded form. + * @brief The scheme part of the URL in URL-encoded form. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *URLEncodedScheme; /*! - * The host part of the URL. + * @brief The host part of the URL. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *host; /*! - * The host part of the URL in URL-encoded form. + * @brief The host part of the URL in URL-encoded form. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *URLEncodedHost; /*! - * The port part of the URL. + * @brief The port part of the URL. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFNumber *port; /*! - * The user part of the URL. + * @brief The user part of the URL. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *user; /*! - * The user part of the URL in URL-encoded form. + * @brief The user part of the URL in URL-encoded form. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *URLEncodedUser; /*! - * The password part of the URL. + * @brief The password part of the URL. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *password; /*! - * The password part of the URL in URL-encoded form. + * @brief The password part of the URL in URL-encoded form. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *URLEncodedPassword; /*! - * The path part of the URL. + * @brief The path part of the URL. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *path; /*! - * The path part of the URL in URL-encoded form. + * @brief The path part of the URL in URL-encoded form. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *URLEncodedPath; /*! - * The path of the URL split into components. + * @brief The path of the URL split into components. * * The first component must always be empty to designate the root. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFArray OF_GENERIC(OFString *) *pathComponents; /*! - * The last path component of the URL. + * @brief The last path component of the URL. * * Returns the empty string if the path is the root. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *lastPathComponent; /*! - * The query part of the URL. + * @brief The query part of the URL. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *query; /*! - * The query part of the URL in URL-encoded form. + * @brief The query part of the URL in URL-encoded form. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *URLEncodedQuery; /*! - * The fragment part of the URL. + * @brief The fragment part of the URL. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *fragment; /*! - * The fragment part of the URL in URL-encoded form. + * @brief The fragment part of the URL in URL-encoded form. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *URLEncodedFragment; /*! - * The URL as a string. + * @brief The URL as a string. */ @property (readonly, nonatomic) OFString *string; /*! - * The local file system representation for a file URL. + * @brief The local file system representation for a file URL. * * @note This only exists for URLs with the file scheme and throws an exception * otherwise. * */ Index: src/OFURLHandler.h ================================================================== --- src/OFURLHandler.h +++ src/OFURLHandler.h @@ -31,11 +31,11 @@ { OFString *_scheme; } /*! - * The scheme this OFURLHandler handles. + * @brief The scheme this OFURLHandler handles. */ @property (readonly, nonatomic) OFString *scheme; /*! * @brief Registers the specified class as the handler for the specified scheme. Index: src/OFXMLAttribute.h ================================================================== --- src/OFXMLAttribute.h +++ src/OFXMLAttribute.h @@ -30,16 +30,16 @@ @public OFString *_name, *_Nullable _namespace, *_stringValue; } /*! - * The name of the attribute. + * @brief The name of the attribute. */ @property (readonly, nonatomic) OFString *name; /*! - * The namespace of the attribute. + * @brief The namespace of the attribute. */ #ifndef __cplusplus @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *namespace; #else @property OF_NULLABLE_PROPERTY (readonly, nonatomic, getter=namespace) Index: src/OFXMLElement+Serialization.h ================================================================== --- src/OFXMLElement+Serialization.h +++ src/OFXMLElement+Serialization.h @@ -26,11 +26,12 @@ } #endif @interface OFXMLElement (OFSerialization) /*! - * The XML element interpreted as serialization and parsed into an object. + * @brief The XML element interpreted as serialization and parsed into an + * object. */ @property (readonly, nonatomic) id objectByDeserializing; @end OF_ASSUME_NONNULL_END Index: src/OFXMLElement.h ================================================================== --- src/OFXMLElement.h +++ src/OFXMLElement.h @@ -38,43 +38,44 @@ _namespaces; OFMutableArray OF_GENERIC(OFXMLNode *) *_Nullable _children; } /*! - * The name of the element. + * @brief The name of the element. */ @property (copy, nonatomic) OFString *name; /*! - * The namespace of the element. + * @brief The namespace of the element. */ #ifndef __cplusplus @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *namespace; #else @property OF_NULLABLE_PROPERTY (copy, nonatomic, getter=namespace, setter=setNamespace:) OFString *namespace_; #endif /*! - * The default namespace for the element to be used if there is no parent. + * @brief The default namespace for the element to be used if there is no + * parent. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *defaultNamespace; /*! - * An array with the attributes of the element + * @brief An array with the attributes of the element. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFArray OF_GENERIC(OFXMLAttribute *) *attributes; /*! - * An array of OFXMLNodes with all children of the element. + * @brief An array of OFXMLNodes with all children of the element. */ @property OF_NULLABLE_PROPERTY (nonatomic, copy) OFArray OF_GENERIC(OFXMLNode *) *children; /*! - * All children that are elements. + * @brief All children that are elements. */ @property (readonly, nonatomic) OFArray OF_GENERIC(OFXMLElement *) *elements; /*! * @brief Creates a new XML element with the specified name. Index: src/OFXMLElementBuilder.h ================================================================== --- src/OFXMLElementBuilder.h +++ src/OFXMLElementBuilder.h @@ -108,11 +108,11 @@ OFMutableArray OF_GENERIC(OFXMLElement *) *_stack; id _Nullable _delegate; } /*! - * The delegate for the OFXMLElementBuilder. + * @brief The delegate for the OFXMLElementBuilder. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) id delegate; /*! Index: src/OFXMLNode.h ================================================================== --- src/OFXMLNode.h +++ src/OFXMLNode.h @@ -26,39 +26,39 @@ * * @brief A class which stores an XML element. */ @interface OFXMLNode: OFObject /*! - * The contents of the node as a string value. + * @brief The contents of the node as a string value. * * For an @ref OFXMLElement, setting it removes all children and creates a * single child with the specified string value. */ @property (nonatomic, copy) OFString *stringValue; /*! - * The contents of the receiver as a decimal value. + * @brief The contents of the receiver as a decimal value. */ @property (readonly, nonatomic) intmax_t decimalValue; /*! - * The contents of the receiver as a hexadecimal value. + * @brief The contents of the receiver as a hexadecimal value. */ @property (readonly, nonatomic) uintmax_t hexadecimalValue; /*! - * The contents of the receiver as a float value. + * @brief The contents of the receiver as a float value. */ @property (readonly, nonatomic) float floatValue; /*! - * The contents of the receiver as a double value. + * @brief The contents of the receiver as a double value. */ @property (readonly, nonatomic) double doubleValue; /*! - * A string representing the node as an XML string. + * @brief A string representing the node as an XML string. */ @property (readonly, nonatomic) OFString *XMLString; - (instancetype)init OF_UNAVAILABLE; - (instancetype)initWithSerialization: (OFXMLElement *)element OF_UNAVAILABLE; Index: src/OFXMLParser.h ================================================================== --- src/OFXMLParser.h +++ src/OFXMLParser.h @@ -172,27 +172,27 @@ of_string_encoding_t _encoding; size_t _depthLimit; } /*! - * The delegate that is used by the XML parser. + * @brief The delegate that is used by the XML parser. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) id delegate; /*! - * The current line number. + * @brief The current line number. */ @property (readonly, nonatomic) size_t lineNumber; /*! - * @return Whether the XML parser has finished parsing. + * @brief Whether the XML parser has finished parsing. */ @property (readonly, nonatomic) bool hasFinishedParsing; /*! - * The depth limit for the XML parser. + * @brief The depth limit for the XML parser. * * If the depth limit is exceeded, an OFMalformedXMLException is thrown. * * The default is 32. 0 means unlimited (insecure!). */ Index: src/OFZIPArchive.h ================================================================== --- src/OFZIPArchive.h +++ src/OFZIPArchive.h @@ -49,17 +49,17 @@ *_pathToEntryMap; OFStream *_Nullable _lastReturnedStream; } /*! - * The archive comment. + * @brief The archive comment. */ @property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *archiveComment; /*! - * The entries in the central directory of the archive as an array of objects - * of class @ref OFZIPArchiveEntry. + * @brief The entries in the central directory of the archive as an array of + * objects of class @ref OFZIPArchiveEntry. * * The objects of the array have the same order as the entries in the central * directory, which does not need to be the order in which the actual files are * stored. */ Index: src/OFZIPArchiveEntry.h ================================================================== --- src/OFZIPArchiveEntry.h +++ src/OFZIPArchiveEntry.h @@ -102,54 +102,54 @@ uint32_t _versionSpecificAttributes; int64_t _localFileHeaderOffset; } /*! - * The file name of the entry. + * @brief The file name of the entry. */ @property (readonly, copy, nonatomic) OFString *fileName; /*! - * The comment of the entry's file. + * @brief The comment of the entry's file. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *fileComment; /*! - * The extra field of the entry. + * @brief The extra field of the entry. * * The item size *must* be 1! */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFData *extraField; /*! - * The version which made the entry. + * @brief The version which made the entry. * * The lower 8 bits are the ZIP specification version.@n * The upper 8 bits are the attribute compatibility. * See @ref of_zip_archive_entry_attribute_compatibility. */ @property (readonly, nonatomic) uint16_t versionMadeBy; /*! - * The minimum version required to extract the file. + * @brief The minimum version required to extract the file. * * The lower 8 bits are the ZIP specification version.@n * The upper 8 bits are the attribute compatibility. * See @ref of_zip_archive_entry_attribute_compatibility. */ @property (readonly, nonatomic) uint16_t minVersionNeeded; /*! - * The last modification date of the entry's file. + * @brief The last modification date of the entry's file. * * @note Due to limitations of the ZIP format, this has only 2 second precision. */ @property (readonly, retain, nonatomic) OFDate *modificationDate; /*! - * The compression method of the entry. + * @brief The compression method of the entry. * * Supported values are: * Value | Description * --------------------------------------------------|--------------- * OF_ZIP_ARCHIVE_ENTRY_COMPRESSION_METHOD_NONE | No compression @@ -159,34 +159,34 @@ * Other values may be returned, but the file cannot be extracted then. */ @property (readonly, nonatomic) uint16_t compressionMethod; /*! - * The compressed size of the entry's file. + * @brief The compressed size of the entry's file. */ @property (readonly, nonatomic) uint64_t compressedSize; /*! - * The uncompressed size of the entry's file. + * @brief The uncompressed size of the entry's file. */ @property (readonly, nonatomic) uint64_t uncompressedSize; /*! - * The CRC32 checksum of the entry's file. + * @brief The CRC32 checksum of the entry's file. */ @property (readonly, nonatomic) uint32_t CRC32; /*! - * The version specific attributes. + * @brief The version specific attributes. * * The meaning of the version specific attributes depends on the attribute * compatibility part of the version that made the entry. */ @property (readonly, nonatomic) uint32_t versionSpecificAttributes; /*! - * The general purpose bit flag of the entry. + * @brief The general purpose bit flag of the entry. * * See the ZIP specification for details. */ @property (readonly, nonatomic) uint16_t generalPurposeBitFlag; Index: src/exceptions/OFAcceptFailedException.h ================================================================== --- src/exceptions/OFAcceptFailedException.h +++ src/exceptions/OFAcceptFailedException.h @@ -33,16 +33,16 @@ id _socket; int _errNo; } /*! - * The socket which could not accept a connection. + * @brief The socket which could not accept a connection. */ @property (readonly, nonatomic) id socket; /*! - * @return The errno from when the exception was created. + * @brief The errno from when the exception was created. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFAddressTranslationFailedException.h ================================================================== --- src/exceptions/OFAddressTranslationFailedException.h +++ src/exceptions/OFAddressTranslationFailedException.h @@ -34,11 +34,11 @@ OFString *_host; int _error; } /*! - * The host for which the address translation was requested. + * @brief The host for which the address translation was requested. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *host; /*! * @brief Creates a new, autoreleased address translation failed exception. Index: src/exceptions/OFAlreadyConnectedException.h ================================================================== --- src/exceptions/OFAlreadyConnectedException.h +++ src/exceptions/OFAlreadyConnectedException.h @@ -33,11 +33,11 @@ { id _socket; } /*! - * The socket which is already connected. + * @brief The socket which is already connected. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) id socket; /*! * @brief Creates a new, autoreleased already connected exception. Index: src/exceptions/OFBindFailedException.h ================================================================== --- src/exceptions/OFBindFailedException.h +++ src/exceptions/OFBindFailedException.h @@ -35,26 +35,26 @@ uint16_t _port; int _errNo; } /*! - * The host on which binding failed. + * @brief The host on which binding failed. */ @property (readonly, nonatomic) OFString *host; /*! - * The port on which binding failed. + * @brief The port on which binding failed. */ @property (readonly, nonatomic) uint16_t port; /*! - * The socket which could not be bound. + * @brief The socket which could not be bound. */ @property (readonly, nonatomic) id socket; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFChangeCurrentDirectoryPathFailedException.h ================================================================== --- src/exceptions/OFChangeCurrentDirectoryPathFailedException.h +++ src/exceptions/OFChangeCurrentDirectoryPathFailedException.h @@ -31,16 +31,17 @@ OFString *_path; int _errNo; } /*! - * The path of the directory to which the current path could not be changed. + * @brief The path of the directory to which the current path could not be + * changed. */ @property (readonly, nonatomic) OFString *path; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFConditionBroadcastFailedException.h ================================================================== --- src/exceptions/OFConditionBroadcastFailedException.h +++ src/exceptions/OFConditionBroadcastFailedException.h @@ -35,11 +35,11 @@ { OFCondition *_condition; } /*! - * The condition which could not be broadcasted. + * @brief The condition which could not be broadcasted. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFCondition *condition; /*! * @brief Returns a new, autoreleased condition broadcast failed exception. Index: src/exceptions/OFConditionSignalFailedException.h ================================================================== --- src/exceptions/OFConditionSignalFailedException.h +++ src/exceptions/OFConditionSignalFailedException.h @@ -35,11 +35,11 @@ { OFCondition *_condition; } /*! - * The condition which could not be signaled. + * @brief The condition which could not be signaled. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFCondition *condition; /*! * @brief Creates a new, autoreleased condition signal failed exception. Index: src/exceptions/OFConditionStillWaitingException.h ================================================================== --- src/exceptions/OFConditionStillWaitingException.h +++ src/exceptions/OFConditionStillWaitingException.h @@ -36,11 +36,11 @@ { OFCondition *_condition; } /*! - * The condition for which is still being waited. + * @brief The condition for which is still being waited. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFCondition *condition; /*! * @brief Creates a new, autoreleased condition still waiting exception. Index: src/exceptions/OFConditionWaitFailedException.h ================================================================== --- src/exceptions/OFConditionWaitFailedException.h +++ src/exceptions/OFConditionWaitFailedException.h @@ -35,11 +35,11 @@ { OFCondition *_condition; } /*! - * The condition for which could not be waited. + * @brief The condition for which could not be waited. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFCondition *condition; /*! * @brief Creates a new, autoreleased condition wait failed exception. Index: src/exceptions/OFConnectionFailedException.h ================================================================== --- src/exceptions/OFConnectionFailedException.h +++ src/exceptions/OFConnectionFailedException.h @@ -35,26 +35,26 @@ uint16_t _port; int _errNo; } /*! - * The socket which could not connect. + * @brief The socket which could not connect. */ @property (readonly, nonatomic) id socket; /*! - * The host to which the connection failed. + * @brief The host to which the connection failed. */ @property (readonly, nonatomic) OFString *host; /*! - * The port on the host to which the connection failed. + * @brief The port on the host to which the connection failed. */ @property (readonly, nonatomic) uint16_t port; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFCopyItemFailedException.h ================================================================== --- src/exceptions/OFCopyItemFailedException.h +++ src/exceptions/OFCopyItemFailedException.h @@ -29,21 +29,21 @@ OFString *_sourcePath, *_destinationPath; int _errNo; } /*! - * The path of the source item. + * @brief The path of the source item. */ @property (readonly, nonatomic) OFString *sourcePath; /*! - * The destination path. + * @brief The destination path. */ @property (readonly, nonatomic) OFString *destinationPath; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFCreateDirectoryFailedException.h ================================================================== --- src/exceptions/OFCreateDirectoryFailedException.h +++ src/exceptions/OFCreateDirectoryFailedException.h @@ -32,16 +32,16 @@ OFURL *_URL; int _errNo; } /*! - * The URL of the directory which couldn't be created. + * @brief The URL of the directory which couldn't be created. */ @property (readonly, nonatomic) OFURL *URL; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFCreateSymbolicLinkFailedException.h ================================================================== --- src/exceptions/OFCreateSymbolicLinkFailedException.h +++ src/exceptions/OFCreateSymbolicLinkFailedException.h @@ -33,21 +33,21 @@ OFString *_target; int _errNo; } /*! - * The URL at which the symlink should have been created. + * @brief The URL at which the symlink should have been created. */ @property (readonly, nonatomic) OFURL *URL; /*! - * The target for the symlink. + * @brief The target for the symlink. */ @property (readonly, nonatomic) OFString *target; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFEnumerationMutationException.h ================================================================== --- src/exceptions/OFEnumerationMutationException.h +++ src/exceptions/OFEnumerationMutationException.h @@ -30,11 +30,11 @@ { id _object; } /*! - * The object which was mutated during enumeration. + * @brief The object which was mutated during enumeration. */ @property (readonly, nonatomic) id object; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFGetOptionFailedException.h ================================================================== --- src/exceptions/OFGetOptionFailedException.h +++ src/exceptions/OFGetOptionFailedException.h @@ -31,16 +31,16 @@ OFStream *_stream; int _errNo; } /*! - * The stream for which the option could not be retrieved. + * @brief The stream for which the option could not be retrieved. */ @property (readonly, nonatomic) OFStream *stream; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFHTTPRequestFailedException.h ================================================================== --- src/exceptions/OFHTTPRequestFailedException.h +++ src/exceptions/OFHTTPRequestFailedException.h @@ -37,16 +37,16 @@ OFHTTPRequest *_request; OFHTTPResponse *_response; } /*! - * The HTTP request which failed. + * @brief The HTTP request which failed. */ @property (readonly, nonatomic) OFHTTPRequest *request; /*! - * The response for the failed HTTP request. + * @brief The response for the failed HTTP request. */ @property (readonly, nonatomic) OFHTTPResponse *response; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFHashAlreadyCalculatedException.h ================================================================== --- src/exceptions/OFHashAlreadyCalculatedException.h +++ src/exceptions/OFHashAlreadyCalculatedException.h @@ -29,11 +29,11 @@ { id _object; } /*! - * The hash which has already been calculated. + * @brief The hash which has already been calculated. */ @property (readonly, nonatomic) id object; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFInitializationFailedException.h ================================================================== --- src/exceptions/OFInitializationFailedException.h +++ src/exceptions/OFInitializationFailedException.h @@ -29,11 +29,11 @@ { Class _inClass; } /*! - * The class for which initialization failed. + * @brief The class for which initialization failed. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) Class inClass; /*! * @brief Creates a new, autoreleased initialization failed exception. Index: src/exceptions/OFInvalidJSONException.h ================================================================== --- src/exceptions/OFInvalidJSONException.h +++ src/exceptions/OFInvalidJSONException.h @@ -29,16 +29,16 @@ OFString *_string; size_t _line; } /*! - * The string containing the invalid JSON representation. + * @brief The string containing the invalid JSON representation. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *string; /*! - * The line in which parsing the JSON representation failed. + * @brief The line in which parsing the JSON representation failed. */ @property (readonly, nonatomic) size_t line; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFLinkFailedException.h ================================================================== --- src/exceptions/OFLinkFailedException.h +++ src/exceptions/OFLinkFailedException.h @@ -31,21 +31,21 @@ OFURL *_sourceURL, *_destinationURL; int _errNo; } /*! - * A URL with the source for the link. + * @brief A URL with the source for the link. */ @property (readonly, nonatomic) OFURL *sourceURL; /*! - * A URL with the destination for the link. + * @brief A URL with the destination for the link. */ @property (readonly, nonatomic) OFURL *destinationURL; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFListenFailedException.h ================================================================== --- src/exceptions/OFListenFailedException.h +++ src/exceptions/OFListenFailedException.h @@ -33,21 +33,21 @@ id _socket; int _backLog, _errNo; } /*! - * The socket which failed to listen. + * @brief The socket which failed to listen. */ @property (readonly, nonatomic) id socket; /*! - * The requested back log. + * @brief The requested back log. */ @property (readonly, nonatomic) int backLog; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFLockFailedException.h ================================================================== --- src/exceptions/OFLockFailedException.h +++ src/exceptions/OFLockFailedException.h @@ -29,11 +29,11 @@ { id _lock; } /*! - * The lock which could not be locked. + * @brief The lock which could not be locked. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) id lock; /*! * @brief Creates a new, autoreleased lock failed exception. Index: src/exceptions/OFMalformedXMLException.h ================================================================== --- src/exceptions/OFMalformedXMLException.h +++ src/exceptions/OFMalformedXMLException.h @@ -30,11 +30,11 @@ { OFXMLParser *_parser; } /*! - * The parser which encountered malformed XML. + * @brief The parser which encountered malformed XML. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFXMLParser *parser; /*! * @brief Creates a new, autoreleased malformed XML exception. Index: src/exceptions/OFMemoryNotPartOfObjectException.h ================================================================== --- src/exceptions/OFMemoryNotPartOfObjectException.h +++ src/exceptions/OFMemoryNotPartOfObjectException.h @@ -30,16 +30,16 @@ void *_Nullable _pointer; id _object; } /*! - * A pointer to the memory which is not part of the object. + * @brief A pointer to the memory which is not part of the object. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) void *pointer; /*! - * The object which the memory is not part of. + * @brief The object which the memory is not part of. */ @property (readonly, nonatomic) id object; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFMoveItemFailedException.h ================================================================== --- src/exceptions/OFMoveItemFailedException.h +++ src/exceptions/OFMoveItemFailedException.h @@ -29,21 +29,21 @@ OFString *_sourcePath, *_destinationPath; int _errNo; } /*! - * The original path. + * @brief The original path. */ @property (readonly, nonatomic) OFString *sourcePath; /*! - * The new path. + * @brief The new path. */ @property (readonly, nonatomic) OFString *destinationPath; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFNotImplementedException.h ================================================================== --- src/exceptions/OFNotImplementedException.h +++ src/exceptions/OFNotImplementedException.h @@ -30,16 +30,16 @@ SEL _selector; id _object; } /*! - * The selector which is not or not fully implemented. + * @brief The selector which is not or not fully implemented. */ @property (readonly, nonatomic) SEL selector; /*! - * The object which does not (fully) implement the selector. + * @brief The object which does not (fully) implement the selector. */ @property (readonly, nonatomic) id object; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFNotOpenException.h ================================================================== --- src/exceptions/OFNotOpenException.h +++ src/exceptions/OFNotOpenException.h @@ -27,11 +27,11 @@ { id _object; } /*! - * The object which is not open, connected or bound. + * @brief The object which is not open, connected or bound. */ @property (readonly, nonatomic) id object; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFObserveFailedException.h ================================================================== --- src/exceptions/OFObserveFailedException.h +++ src/exceptions/OFObserveFailedException.h @@ -31,16 +31,16 @@ OFKernelEventObserver *_observer; int _errNo; } /*! - * The observer which failed to observe. + * @brief The observer which failed to observe. */ @property (readonly, nonatomic) OFKernelEventObserver *observer; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFOpenItemFailedException.h ================================================================== --- src/exceptions/OFOpenItemFailedException.h +++ src/exceptions/OFOpenItemFailedException.h @@ -33,26 +33,26 @@ OFString *_mode; int _errNo; } /*! - * The URL of the item which could not be opened. + * @brief The URL of the item which could not be opened. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFURL *URL; /*! - * The path of the item which could not be opened. + * @brief The path of the item which could not be opened. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *path; /*! - * The mode in which the item should have been opened. + * @brief The mode in which the item should have been opened. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *mode; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFOutOfMemoryException.h ================================================================== --- src/exceptions/OFOutOfMemoryException.h +++ src/exceptions/OFOutOfMemoryException.h @@ -28,11 +28,11 @@ { size_t _requestedSize; } /*! - * The size of the memory that could not be allocated. + * @brief The size of the memory that could not be allocated. */ @property (readonly, nonatomic) size_t requestedSize; /*! * @brief Creates a new, autoreleased no memory exception. Index: src/exceptions/OFReadOrWriteFailedException.h ================================================================== --- src/exceptions/OFReadOrWriteFailedException.h +++ src/exceptions/OFReadOrWriteFailedException.h @@ -31,21 +31,21 @@ size_t _requestedLength; int _errNo; } /*! - * The stream which caused the read or write failed exception. + * @brief The stream which caused the read or write failed exception. */ @property (readonly, nonatomic) id object; /*! - * The requested length of the data that could not be read / written. + * @brief The requested length of the data that could not be read / written. */ @property (readonly, nonatomic) size_t requestedLength; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFRemoveItemFailedException.h ================================================================== --- src/exceptions/OFRemoveItemFailedException.h +++ src/exceptions/OFRemoveItemFailedException.h @@ -31,16 +31,16 @@ OFURL *_URL; int _errNo; } /*! - * The URL of the item which could not be removed. + * @brief The URL of the item which could not be removed. */ @property (readonly, nonatomic) OFURL *URL; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFRetrieveItemAttributesFailedException.h ================================================================== --- src/exceptions/OFRetrieveItemAttributesFailedException.h +++ src/exceptions/OFRetrieveItemAttributesFailedException.h @@ -32,16 +32,16 @@ OFURL *_URL; int _errNo; } /*! - * The URL of the item whose attributes could not be retrieved. + * @brief The URL of the item whose attributes could not be retrieved. */ @property (readonly, nonatomic) OFURL *URL; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFSandboxActivationFailedException.h ================================================================== --- src/exceptions/OFSandboxActivationFailedException.h +++ src/exceptions/OFSandboxActivationFailedException.h @@ -32,16 +32,16 @@ OFSandbox *_sandbox; int _errNo; } /*! - * The sandbox which could not be activated. + * @brief The sandbox which could not be activated. */ @property (readonly, nonatomic) OFSandbox *sandbox; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFSeekFailedException.h ================================================================== --- src/exceptions/OFSeekFailedException.h +++ src/exceptions/OFSeekFailedException.h @@ -31,26 +31,26 @@ of_offset_t _offset; int _whence, _errNo; } /*! - * The stream for which seeking failed. + * @brief The stream for which seeking failed. */ @property (readonly, nonatomic) OFSeekableStream *stream; /*! - * The offset to which seeking failed. + * @brief The offset to which seeking failed. */ @property (readonly, nonatomic) of_offset_t offset; /*! - * To what the offset is relative. + * @brief To what the offset is relative. */ @property (readonly, nonatomic) int whence; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFSetItemAttributesFailedException.h ================================================================== --- src/exceptions/OFSetItemAttributesFailedException.h +++ src/exceptions/OFSetItemAttributesFailedException.h @@ -35,26 +35,26 @@ of_file_attribute_key_t _failedAttribute; int _errNo; } /*! - * The URL of the item whose attributes could not be set. + * @brief The URL of the item whose attributes could not be set. */ @property (readonly, nonatomic) OFURL *URL; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; /*! - * The attributes that should have been set. + * @brief The attributes that should have been set. */ @property (readonly, nonatomic) of_file_attributes_t attributes; /*! - * The first attribute that could not be set. + * @brief The first attribute that could not be set. */ @property (readonly, nonatomic) of_file_attribute_key_t failedAttribute; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFSetOptionFailedException.h ================================================================== --- src/exceptions/OFSetOptionFailedException.h +++ src/exceptions/OFSetOptionFailedException.h @@ -31,16 +31,16 @@ OFStream *_stream; int _errNo; } /*! - * The stream for which the option could not be set. + * @brief The stream for which the option could not be set. */ @property (readonly, nonatomic) OFStream *stream; /*! - * The errno of the error that occurred. + * @brief The errno of the error that occurred. */ @property (readonly, nonatomic) int errNo; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFStillLockedException.h ================================================================== --- src/exceptions/OFStillLockedException.h +++ src/exceptions/OFStillLockedException.h @@ -29,11 +29,11 @@ { id _lock; } /*! - * The lock which is still locked. + * @brief The lock which is still locked. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) id lock; /*! * @brief Creates a new, autoreleased still locked exception. Index: src/exceptions/OFThreadJoinFailedException.h ================================================================== --- src/exceptions/OFThreadJoinFailedException.h +++ src/exceptions/OFThreadJoinFailedException.h @@ -34,11 +34,11 @@ { OFThread *_thread; } /*! - * The thread which could not be joined. + * @brief The thread which could not be joined. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFThread *thread; /*! * @brief Creates a new, autoreleased thread join failed exception. Index: src/exceptions/OFThreadStartFailedException.h ================================================================== --- src/exceptions/OFThreadStartFailedException.h +++ src/exceptions/OFThreadStartFailedException.h @@ -34,11 +34,11 @@ { OFThread *_thread; } /*! - * The thread which could not be started. + * @brief The thread which could not be started. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFThread *thread; /*! * @brief Creates a new, autoreleased thread start failed exception. Index: src/exceptions/OFThreadStillRunningException.h ================================================================== --- src/exceptions/OFThreadStillRunningException.h +++ src/exceptions/OFThreadStillRunningException.h @@ -34,11 +34,11 @@ { OFThread *_thread; } /*! - * The thread which is still running. + * @brief The thread which is still running. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFThread *thread; /*! * @brief Creates a new, autoreleased thread still running exception. Index: src/exceptions/OFUnboundNamespaceException.h ================================================================== --- src/exceptions/OFUnboundNamespaceException.h +++ src/exceptions/OFUnboundNamespaceException.h @@ -31,20 +31,20 @@ OFString *_namespace; OFXMLElement *_element; } /*! - * The unbound namespace. + * @brief The unbound namespace. */ #ifndef __cplusplus @property (readonly, nonatomic) OFString *namespace; #else @property (readonly, nonatomic, getter=namespace) OFString *namespace_; #endif /*! - * The element in which the namespace was not bound. + * @brief The element in which the namespace was not bound. */ @property (readonly, nonatomic) OFXMLElement *element; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFUnboundPrefixException.h ================================================================== --- src/exceptions/OFUnboundPrefixException.h +++ src/exceptions/OFUnboundPrefixException.h @@ -31,16 +31,16 @@ OFString *_prefix; OFXMLParser *_parser; } /*! - * The unbound prefix. + * @brief The unbound prefix. */ @property (readonly, nonatomic) OFString *prefix; /*! - * The parser which encountered the unbound prefix. + * @brief The parser which encountered the unbound prefix. */ @property (readonly, nonatomic) OFXMLParser *parser; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFUndefinedKeyException.h ================================================================== --- src/exceptions/OFUndefinedKeyException.h +++ src/exceptions/OFUndefinedKeyException.h @@ -31,21 +31,21 @@ OFString *_key; id _Nullable _value; } /*! - * The object on which the key is undefined. + * @brief The object on which the key is undefined. */ @property (readonly, nonatomic) id object; /*! - * The key which is undefined. + * @brief The key which is undefined. */ @property (readonly, nonatomic) OFString *key; /*! - * The value for the undefined key + * @brief The value for the undefined key */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) id value; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFUnknownXMLEntityException.h ================================================================== --- src/exceptions/OFUnknownXMLEntityException.h +++ src/exceptions/OFUnknownXMLEntityException.h @@ -29,11 +29,11 @@ { OFString *_entityName; } /*! - * The name of the unknown XML entity. + * @brief The name of the unknown XML entity. */ @property (readonly, nonatomic) OFString *entityName; /*! * @brief Creates a new, autoreleased unknown XML entity exception. Index: src/exceptions/OFUnlockFailedException.h ================================================================== --- src/exceptions/OFUnlockFailedException.h +++ src/exceptions/OFUnlockFailedException.h @@ -29,11 +29,11 @@ { id _lock; } /*! - * The lock which could not be unlocked. + * @brief The lock which could not be unlocked. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) id lock; /*! * @brief Creates a new, autoreleased unlock failed exception. Index: src/exceptions/OFUnsupportedProtocolException.h ================================================================== --- src/exceptions/OFUnsupportedProtocolException.h +++ src/exceptions/OFUnsupportedProtocolException.h @@ -32,11 +32,11 @@ { OFURL *_URL; } /*! - * The URL whose protocol is unsupported. + * @brief The URL whose protocol is unsupported. */ @property (readonly, nonatomic) OFURL *URL; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFUnsupportedVersionException.h ================================================================== --- src/exceptions/OFUnsupportedVersionException.h +++ src/exceptions/OFUnsupportedVersionException.h @@ -29,11 +29,11 @@ { OFString *_version; } /*! - * The version which is unsupported. + * @brief The version which is unsupported. */ @property (readonly, nonatomic) OFString *version; + (instancetype)exception OF_UNAVAILABLE; Index: src/exceptions/OFWriteFailedException.h ================================================================== --- src/exceptions/OFWriteFailedException.h +++ src/exceptions/OFWriteFailedException.h @@ -28,11 +28,11 @@ { size_t _bytesWritten; } /*! - * The number of bytes already written before the write failed. + * @brief The number of bytes already written before the write failed. * * This can be used to make sure that a retry does not write data already * written before. */ @property (readonly, nonatomic) size_t bytesWritten;