@@ -18,11 +18,11 @@ #import "OFObject.h" #import "OFString.h" OF_ASSUME_NONNULL_BEGIN -/*! +/** * @class OFSystemInfo OFSystemInfo.h ObjFW/OFSystemInfo.h * * @brief A class for querying information about the system. */ OF_SUBCLASSING_RESTRICTED @@ -61,65 +61,65 @@ # ifdef OF_WINDOWS @property (class, readonly, nonatomic, getter=isWindowsNT) bool windowsNT; # endif #endif -/*! +/** * @brief Returns the size of a page. * * @return The size of a page */ + (size_t)pageSize; -/*! +/** * @brief Returns the number of CPUs installed in the system. * * A CPU with multiple cores counts as multiple CPUs. * * @return The number of CPUs installed in the system */ + (size_t)numberOfCPUs; -/*! +/** * @brief The version of ObjFW. * * @return The version of ObjFW */ + (OFString *)ObjFWVersion; -/*! +/** * @brief The major version of ObjFW. * * @return The major version of ObjFW */ + (unsigned int)ObjFWVersionMajor; -/*! +/** * @brief The minor version of ObjFW. * * @return The minor version of ObjFW */ + (unsigned int)ObjFWVersionMinor; -/*! +/** * @brief Returns the name of the operating system the application is running * on. * * @return The name of the operating system the application is running on */ + (nullable OFString *)operatingSystemName; -/*! +/** * @brief Returns the version of the operating system the application is * running on. * * @return The version of the operating system the application is running on */ + (nullable OFString *)operatingSystemVersion; #ifdef OF_HAVE_FILES -/*! +/** * @brief Returns the path where user data for the application can be stored. * * On Unix systems, this adheres to the XDG Base Directory specification.@n * On Mac OS X and iOS, it uses the `NSApplicationSupportDirectory` directory.@n * On Windows, it uses the `APPDATA` environment variable.@n @@ -127,11 +127,11 @@ * * @return The path where user data for the application can be stored */ + (nullable OFString *)userDataPath; -/*! +/** * @brief Returns the path where user configuration for the application can be * stored. * * On Unix systems, this adheres to the XDG Base Directory specification.@n * On Mac OS X and iOS, it uses the `Preferences` directory inside of @@ -142,39 +142,39 @@ * @return The path where user configuration for the application can be stored */ + (nullable OFString *)userConfigPath; #endif -/*! +/** * @brief Returns the vendor of the CPU. * * If the vendor could not be determined, `nil` is returned instead. * * @return The vendor of the CPU */ + (nullable OFString *)CPUVendor; -/*! +/** * @brief Returns the model of the CPU. * * If the model could not be determined, `nil` is returned instead. * * @return The model of the CPU */ + (nullable OFString *)CPUModel; #if defined(OF_X86_64) || defined(OF_X86) || defined(DOXYGEN) -/*! +/** * @brief Returns whether the CPU supports MMX. * * @note This method is only available on x86 and x86_64. * * @return Whether the CPU supports MMX */ + (bool)supportsMMX; -/*! +/** * @brief Returns whether the CPU supports SSE. * * @warning This method only checks CPU support and assumes OS support! * * @note This method is only available on x86 and x86_64. @@ -181,11 +181,11 @@ * * @return Whether the CPU supports SSE */ + (bool)supportsSSE; -/*! +/** * @brief Returns whether the CPU supports SSE2. * * @warning This method only checks CPU support and assumes OS support! * * @note This method is only available on x86 and x86_64. @@ -192,11 +192,11 @@ * * @return Whether the CPU supports SSE2 */ + (bool)supportsSSE2; -/*! +/** * @brief Returns whether the CPU supports SSE3. * * @warning This method only checks CPU support and assumes OS support! * * @note This method is only available on x86 and x86_64. @@ -203,11 +203,11 @@ * * @return Whether the CPU supports SSE3 */ + (bool)supportsSSE3; -/*! +/** * @brief Returns whether the CPU supports SSSE3. * * @warning This method only checks CPU support and assumes OS support! * * @note This method is only available on x86 and x86_64. @@ -214,11 +214,11 @@ * * @return Whether the CPU supports SSSE3 */ + (bool)supportsSSSE3; -/*! +/** * @brief Returns whether the CPU supports SSE4.1. * * @warning This method only checks CPU support and assumes OS support! * * @note This method is only available on x86 and x86_64. @@ -225,11 +225,11 @@ * * @return Whether the CPU supports SSE4.1 */ + (bool)supportsSSE41; -/*! +/** * @brief Returns whether the CPU supports SSE4.2. * * @warning This method only checks CPU support and assumes OS support! * * @note This method is only available on x86 and x86_64. @@ -236,11 +236,11 @@ * * @return Whether the CPU supports SSE4.2 */ + (bool)supportsSSE42; -/*! +/** * @brief Returns whether the CPU supports AVX. * * @warning This method only checks CPU support and assumes OS support! * * @note This method is only available on x86 and x86_64. @@ -247,11 +247,11 @@ * * @return Whether the CPU supports AVX */ + (bool)supportsAVX; -/*! +/** * @brief Returns whether the CPU supports AVX2. * * @warning This method only checks CPU support and assumes OS support! * * @note This method is only available on x86 and x86_64. @@ -258,20 +258,20 @@ * * @return Whether the CPU supports AVX2 */ + (bool)supportsAVX2; -/*! +/** * @brief Returns whether the CPU supports AES-NI. * * @note This method is only available on x86 and x86_64. * * @return Whether the CPU supports AES-NI */ + (bool)supportsAESNI; -/*! +/** * @brief Returns whether the CPU supports Intel SHA Extensions. * * @note This method is only available on x86 and x86_64. * * @return Whether the CPU supports Intel SHA Extensions @@ -278,11 +278,11 @@ */ + (bool)supportsSHAExtensions; #endif #if defined(OF_POWERPC) || defined(OF_POWERPC64) -/*! +/** * @brief Returns whether the CPU and OS support AltiVec. * * @note This method is only available on PowerPC and PowerPC 64. * * @return Whether the CPU and OS support AltiVec @@ -289,11 +289,11 @@ */ + (bool)supportsAltiVec; #endif #ifdef OF_WINDOWS -/*! +/** * @brief Returns whether the application is running on Windows NT. * * @note This method is only available on Windows. * * @return Whether the application is running on Windows NT