@@ -22,11 +22,11 @@ OF_ASSUME_NONNULL_BEGIN @class OFData; -/*! +/** * @class OFWindowsRegistryKey \ * OFWindowsRegistryKey.h ObjFW/OFWindowsRegistryKey.h */ OF_SUBCLASSING_RESTRICTED @interface OFWindowsRegistryKey: OFObject @@ -33,48 +33,48 @@ { HKEY _hKey; bool _close; } -/*! +/** * @brief Returns the OFWindowsRegistryKey for the HKEY_CLASSES_ROOT key. * * @return The OFWindowsRegistryKey for the HKEY_CLASSES_ROOT key */ + (instancetype)classesRootKey; -/*! +/** * @brief Returns the OFWindowsRegistryKey for the HKEY_CURRENT_CONFIG key. * * @return The OFWindowsRegistryKey for the HKEY_CURRENT_CONFIG key */ + (instancetype)currentConfigKey; -/*! +/** * @brief Returns the OFWindowsRegistryKey for the HKEY_CURRENT_USER key. * * @return The OFWindowsRegistryKey for the HKEY_CURRENT_USER key */ + (instancetype)currentUserKey; -/*! +/** * @brief Returns the OFWindowsRegistryKey for the HKEY_LOCAL_MACHINE key. * * @return The OFWindowsRegistryKey for the HKEY_LOCAL_MACHINE key */ + (instancetype)localMachineKey; -/*! +/** * @brief Returns the OFWindowsRegistryKey for the HKEY_USERS key. * * @return The OFWindowsRegistryKey for the HKEY_USERS key */ + (instancetype)usersKey; - (instancetype)init OF_UNAVAILABLE; -/*! +/** * @brief Opens the subkey at the specified path. * * @param path The path of the subkey to open * @param securityAndAccessRights Please refer to the `RegOpenKeyEx()` * documentation for `samDesired` @@ -82,11 +82,11 @@ */ - (nullable OFWindowsRegistryKey *) openSubkeyAtPath: (OFString *)path securityAndAccessRights: (REGSAM)securityAndAccessRights; -/*! +/** * @brief Opens the subkey at the specified path. * * @param path The path of the subkey to open * @param options Please refer to the `RegOpenKeyEx()` documentation for * `ulOptions`. Usually 0. @@ -97,11 +97,11 @@ - (nullable OFWindowsRegistryKey *) openSubkeyAtPath: (OFString *)path options: (DWORD)options securityAndAccessRights: (REGSAM)securityAndAccessRights; -/*! +/** * @brief Creates a subkey at the specified path or opens it if it already * exists. * * @param path The path of the subkey to create * @param securityAndAccessRights Please refer to the `RegCreateKeyEx()` @@ -109,11 +109,11 @@ * @return The subkey with the specified path */ - (OFWindowsRegistryKey *)createSubkeyAtPath: (OFString *)path securityAndAccessRights: (REGSAM)securityAndAccessRights; -/*! +/** * @brief Creates a subkey at the specified path or opens it if it already * exists. * * @param path The path of the subkey to create * @param options Please refer to the `RegCreateKeyEx()` documentation. @@ -133,21 +133,21 @@ options: (DWORD)options securityAndAccessRights: (REGSAM)securityAndAccessRights securityAttributes: (nullable SECURITY_ATTRIBUTES *)securityAttributes disposition: (nullable DWORD *)disposition; -/*! +/** * @brief Returns the data for the specified value at the specified path. * * @param value The name of the value to return * @param type A pointer to store the type of the value, or NULL * @return The data for the specified value */ - (nullable OFData *)dataForValue: (nullable OFString *)value type: (nullable DWORD *)type; -/*! +/** * @brief Sets the data for the specified value. * * @param data The data to set the value to * @param value The name of the value to set * @param type The type for the value @@ -154,38 +154,38 @@ */ - (void)setData: (nullable OFData *)data forValue: (nullable OFString *)value type: (DWORD)type; -/*! +/** * @brief Returns the string for the specified value at the specified path. * * @param value The name of the value to return * @return The string for the specified value */ - (nullable OFString *)stringForValue: (nullable OFString *)value; -/*! +/** * @brief Returns the string for the specified value at the specified path. * * @param value The name of the value to return * @param type A pointer to store the type of the value, or NULL * @return The string for the specified value */ - (nullable OFString *)stringForValue: (nullable OFString *)value type: (nullable DWORD *)type; -/*! +/** * @brief Sets the string for the specified value. * * @param string The string to set the value to * @param value The name of the value to set */ - (void)setString: (nullable OFString *)string forValue: (nullable OFString *)value; -/*! +/** * @brief Sets the string for the specified value. * * @param string The string to set the value to * @param value The name of the value to set * @param type The type for the value @@ -192,21 +192,21 @@ */ - (void)setString: (nullable OFString *)string forValue: (nullable OFString *)value type: (DWORD)type; -/*! +/** * @brief Deletes the specified value. * * @param value The value to delete */ - (void)deleteValue: (nullable OFString *)value; -/*! +/** * @brief Deletes the specified subkey. * * @param subkeyPath The path of the subkey to delete */ - (void)deleteSubkeyAtPath: (OFString *)subkeyPath; @end OF_ASSUME_NONNULL_END