@@ -17,37 +17,37 @@ #import "OFObject.h" OF_ASSUME_NONNULL_BEGIN -/*! @file */ +/** @file */ @class OFDate; -/*! +/** * @brief The type of the archive entry. */ typedef enum of_tar_archive_entry_type_t { - /*! Normal file */ + /** Normal file */ OF_TAR_ARCHIVE_ENTRY_TYPE_FILE = '0', - /*! Hard link */ + /** Hard link */ OF_TAR_ARCHIVE_ENTRY_TYPE_LINK = '1', - /*! Symbolic link */ + /** Symbolic link */ OF_TAR_ARCHIVE_ENTRY_TYPE_SYMLINK = '2', - /*! Character device */ + /** Character device */ OF_TAR_ARCHIVE_ENTRY_TYPE_CHARACTER_DEVICE = '3', - /*! Block device */ + /** Block device */ OF_TAR_ARCHIVE_ENTRY_TYPE_BLOCK_DEVICE = '4', - /*! Directory */ + /** Directory */ OF_TAR_ARCHIVE_ENTRY_TYPE_DIRECTORY = '5', - /*! FIFO */ + /** FIFO */ OF_TAR_ARCHIVE_ENTRY_TYPE_FIFO = '6', - /*! Contiguous file */ + /** Contiguous file */ OF_TAR_ARCHIVE_ENTRY_TYPE_CONTIGUOUS_FILE = '7', } of_tar_archive_entry_type_t; -/*! +/** * @class OFTarArchiveEntry OFTarArchiveEntry.h ObjFW/OFTarArchiveEntry.h * * @brief A class which represents an entry of a tar archive. */ @interface OFTarArchiveEntry: OFObject @@ -62,84 +62,84 @@ OFString *_Nullable _owner, *_Nullable _group; unsigned long _deviceMajor, _deviceMinor; OF_RESERVE_IVARS(OFTarArchiveEntry, 4) } -/*! +/** * @brief The file name of the entry. */ @property (readonly, copy, nonatomic) OFString *fileName; -/*! +/** * @brief The mode of the entry. */ @property (readonly, nonatomic) unsigned long mode; -/*! +/** * @brief The UID of the owner. */ @property (readonly, nonatomic) unsigned long UID; -/*! +/** * @brief The GID of the group. */ @property (readonly, nonatomic) unsigned long GID; -/*! +/** * @brief The size of the file. */ @property (readonly, nonatomic) unsigned long long size; -/*! +/** * @brief The date of the last modification of the file. */ @property (readonly, retain, nonatomic) OFDate *modificationDate; -/*! +/** * @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; -/*! +/** * @brief The file name of the target (for a hard link or symbolic link). */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *targetFileName; -/*! +/** * @brief The owner of the file. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *owner; -/*! +/** * @brief The group of the file. */ @property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *group; -/*! +/** * @brief The device major (if the file is a device). */ @property (readonly, nonatomic) unsigned long deviceMajor; -/*! +/** * @brief The device major (if the file is a device). */ @property (readonly, nonatomic) unsigned long deviceMinor; -/*! +/** * @brief Creates a new OFTarArchiveEntry with the specified file name. * * @param fileName The file name for the OFTarArchiveEntry * @return A new, autoreleased OFTarArchiveEntry */ + (instancetype)entryWithFileName: (OFString *)fileName; - (instancetype)init OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFTarArchiveEntry with the specified * file name. * * @param fileName The file name for the OFTarArchiveEntry * @return An initialized OFTarArchiveEntry