@@ -18,13 +18,13 @@ #import "OFObject.h" #import "OFString.h" OF_ASSUME_NONNULL_BEGIN -/*! @file */ +/** @file */ -/*! +/** * @def OF_LOCALIZED * * @brief Returns the localized string for the specified ID with the specified * arguments inserted. * @@ -36,11 +36,11 @@ fallback: __VA_ARGS__, nil] @class OFMutableArray OF_GENERIC(ObjectType); @class OFDictionary OF_GENERIC(KeyType, ObjectType); -/*! +/** * @class OFLocale OFLocale.h ObjFW/OFLocale.h * * @brief A class for querying the locale and retrieving localized strings. */ OF_SUBCLASSING_RESTRICTED @@ -59,40 +59,40 @@ @property (class, readonly, nullable, nonatomic) OFString *territory; @property (class, readonly, nonatomic) of_string_encoding_t encoding; @property (class, readonly, nullable, nonatomic) OFString *decimalPoint; #endif -/*! +/** * @brief The language of the locale for messages. * * If the language is unknown, it is `nil`. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *language; -/*! +/** * @brief The territory of the locale for messages. * * If the territory is unknown, it is `nil`. */ @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *territory; -/*! +/** * @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; -/*! +/** * @brief The decimal point of the system's locale. */ @property (readonly, nonatomic) OFString *decimalPoint; -/*! +/** * @brief Returns the current OFLocale. * * @warning If you don't use @ref OFApplication, this might be `nil`! In this * case, you need to manually allocate an instance and call * @ref init once. @@ -99,29 +99,29 @@ * * @return The current OFLocale instance */ + (nullable OFLocale *)currentLocale; -/*! +/** * @brief Returns the language of the locale. * * If the language is unknown, `nil` is returned. * * @return The language of the locale. */ + (nullable OFString *)language; -/*! +/** * @brief Returns the territory of the locale. * * If the territory is unknown, `nil` is returned. * * @return The territory of the locale. */ + (nullable OFString *)territory; -/*! +/** * @brief Returns the native 8-bit string encoding for the locale. * * This is useful to encode strings correctly for passing them to operating * system calls. * @@ -129,27 +129,27 @@ * * @return The native 8-bit string encoding for the locale */ + (of_string_encoding_t)encoding; -/*! +/** * @brief Returns the decimal point of the system's locale. * * @return The decimal point of the system's locale */ + (nullable OFString *)decimalPoint; #ifdef OF_HAVE_FILES -/*! +/** * @brief Adds a directory to scan for language files. * * @param path The path to the directory to scan for language files */ + (void)addLanguageDirectory: (OFString *)path; #endif -/*! +/** * @brief Initializes the current OFLocale. * * @warning This sets the locale via `setlocale()`! * * @warning You should never call this yourself, except if you do not use @@ -158,19 +158,19 @@ * call this method. */ - (instancetype)init; #ifdef OF_HAVE_FILES -/*! +/** * @brief Adds a directory to scan for language files. * * @param path The path to the directory to scan for language files */ - (void)addLanguageDirectory: (OFString *)path; #endif -/*! +/** * @brief Returns the localized string for the specified ID, using the fallback * string if it cannot be looked up or is missing. * * @note This takes a variadic argument, terminated by `nil`, that consists of * pairs of variable names and variable values, which will be replaced @@ -188,11 +188,11 @@ * @return The localized string */ - (OFString *)localizedStringForID: (OFConstantString *)ID fallback: (id)fallback, ... OF_SENTINEL; -/*! +/** * @brief Returns the localized string for the specified ID, using the fallback * string if it cannot be looked up or is missing. * * @note This takes a variadic argument, terminated by `nil` and passed as * va_list, that consists of pairs of variable names and variable values,