Index: src/OFApplication.h ================================================================== --- src/OFApplication.h +++ src/OFApplication.h @@ -114,13 +114,11 @@ * * @brief A class which represents the application as an object. * * In order to create a new OFApplication, you should create a class conforming * to the optional @ref OFApplicationDelegate protocol and put - * `OF_APPLICATION_DELEGATE(NameOfYourClass)` in the .m file of that class. The - * only required method of the @ref OFApplicationDelegate protocol is - * @ref OFApplicationDelegate::applicationDidFinishLaunching. + * `OF_APPLICATION_DELEGATE(NameOfYourClass)` in the .m file of that class. */ @interface OFApplication: OFObject { OFString *_programName; OFArray OF_GENERIC(OFString *) *_arguments; Index: src/OFFileManager.h ================================================================== --- src/OFFileManager.h +++ src/OFFileManager.h @@ -76,19 +76,19 @@ * Other URL schemes might not have all types and might have types not listed. */ typedef OFConstantString *of_file_type_t; /*! - * @brief A dictionary mapping keys of type @ref of_file_attribute_key_type_t + * @brief A dictionary mapping keys of type @ref of_file_attribute_key_t * to their attribute values. */ typedef OFDictionary OF_GENERIC(of_file_attribute_key_t, id) *of_file_attributes_t; /*! * @brief A mutable dictionary mapping keys of type - * @ref of_file_attribute_key_type_t to their attribute values. + * @ref of_file_attribute_key_t to their attribute values. */ typedef OFMutableDictionary OF_GENERIC(of_file_attribute_key_t, id) *of_mutable_file_attributes_t; #ifdef __cplusplus @@ -96,93 +96,93 @@ #endif /*! * @brief The size of the file as an @ref OFNumber. * * For convenience, a category on @ref OFDictionary is provided to access this - * via @ref fileSize. + * via @ref OFDictionary#fileSize. */ extern const of_file_attribute_key_t of_file_attribute_key_size; /*! * @brief The type of the file. * * The corresponding value is of type @ref of_file_type_t. * * For convenience, a category on @ref OFDictionary is provided to access this - * via @ref fileType. + * via @ref OFDictionary#fileType. */ extern const of_file_attribute_key_t of_file_attribute_key_type; /*! * @brief The POSIX permissions of the file as an @ref OFNumber. * * For convenience, a category on @ref OFDictionary is provided to access this - * via @ref filePOSIXPermissions. + * via @ref OFDictionary#filePOSIXPermissions. */ extern const of_file_attribute_key_t of_file_attribute_key_posix_permissions; /*! * @brief The POSIX UID of the file as an @ref OFNumber. * * For convenience, a category on @ref OFDictionary is provided to access this - * via @ref filePOSIXUID. + * via @ref OFDictionary#filePOSIXUID. */ extern const of_file_attribute_key_t of_file_attribute_key_posix_uid; /*! * @brief The POSIX GID of the file as an @ref OFNumber. * * For convenience, a category on @ref OFDictionary is provided to access this - * via @ref filePOSIXGID. + * via @ref OFDictionary#filePOSIXGID. */ extern const of_file_attribute_key_t of_file_attribute_key_posix_gid; /*! * @brief The owner of the file as an @ref OFString. * * For convenience, a category on @ref OFDictionary is provided to access this - * via @ref fileOwner. + * via @ref OFDictionary#fileOwner. */ extern const of_file_attribute_key_t of_file_attribute_key_owner; /*! * @brief The group of the file as an @ref OFString. * * For convenience, a category on @ref OFDictionary is provided to access this - * via @ref fileGroup. + * via @ref OFDictionary#fileGroup. */ extern const of_file_attribute_key_t of_file_attribute_key_group; /*! * @brief The last access date of the file as an @ref OFDate. * * For convenience, a category on @ref OFDictionary is provided to access this - * via @ref fileLastAccessDate. + * via @ref OFDictionary#fileLastAccessDate. */ extern const of_file_attribute_key_t of_file_attribute_key_last_access_date; /*! * @brief The last modification date of the file as an @ref OFDate. * * For convenience, a category on @ref OFDictionary is provided to access this - * via @ref fileModificationDate. + * via @ref OFDictionary#fileModificationDate. */ extern const of_file_attribute_key_t of_file_attribute_key_modification_date; /*! * @brief The last status change date of the file as an @ref OFDate. * * For convenience, a category on @ref OFDictionary is provided to access this - * via @ref fileStatusChangeDate. + * via @ref OFDictionary#fileStatusChangeDate. */ extern const of_file_attribute_key_t of_file_attribute_key_status_change_date; /*! * @brief The destination of a symbolic link as an @ref OFString. * * For convenience, a category on @ref OFDictionary is provided to access this - * via @ref fileSymbolicLinkDestination. + * via @ref OFDictionary#fileSymbolicLinkDestination. */ extern const of_file_attribute_key_t of_file_attribute_key_symbolic_link_destination; /*! Index: src/OFLocalization.h ================================================================== --- src/OFLocalization.h +++ src/OFLocalization.h @@ -19,10 +19,19 @@ OF_ASSUME_NONNULL_BEGIN /*! @file */ +/*! + * @def OF_LOCALIZED + * + * @brief Returns the localized string for the specified ID with the specified + * arguments inserted. + * + * @param ID The ID of the localized string to retrieve + * @return The localized string with the specified arguments replaced + */ #define OF_LOCALIZED(ID, ...) \ [[OFLocalization sharedLocalization] \ localizedStringForID: ID \ fallback: __VA_ARGS__, nil] Index: src/OFStream.h ================================================================== --- src/OFStream.h +++ src/OFStream.h @@ -159,11 +159,11 @@ * * On network streams, this might read less than the specified number of bytes. * If you want to read exactly the specified number of bytes, use * @ref readIntoBuffer:exactLength:. Note that a read can even return 0 bytes - * this does not necessarily mean that the stream ended, so you still need to - * check @ref isAtEndOfStream. + * check @ref atEndOfStream. * * @param buffer The buffer into which the data is read * @param length The length of the data that should be read at most. * The buffer *must* be *at least* this big! * @return The number of bytes read @@ -196,11 +196,11 @@ * * On network streams, this might read less than the specified number of bytes. * If you want to read exactly the specified number of bytes, use * @ref asyncReadIntoBuffer:exactLength:target:selector:context:. Note that a * read can even return 0 bytes - this does not necessarily mean that the - * stream ended, so you still need to check @ref isAtEndOfStream. + * stream ended, so you still need to check @ref atEndOfStream. * * @note The stream must implement @ref fileDescriptorForReading and return a * valid file descriptor in order for this to work! * * @param buffer The buffer into which the data is read. @@ -263,11 +263,11 @@ * * On network streams, this might read less than the specified number of bytes. * If you want to read exactly the specified number of bytes, use * @ref asyncReadIntoBuffer:exactLength:block:. Note that a read can even * return 0 bytes - this does not necessarily mean that the stream ended, so - * you still need to check @ref isAtEndOfStream. + * you still need to check @ref atEndOfStream. * * @note The stream must implement @ref fileDescriptorForReading and return a * valid file descriptor in order for this to work! * * @param buffer The buffer into which the data is read. Index: src/OFTarArchiveEntry.h ================================================================== --- src/OFTarArchiveEntry.h +++ src/OFTarArchiveEntry.h @@ -15,10 +15,12 @@ */ #import "OFObject.h" OF_ASSUME_NONNULL_BEGIN + +/*! @file */ @class OFDate; /*! * @brief The type of the archive entry.