diff options
Diffstat (limited to 'source/blender/blenlib/BLI_system.h')
| -rw-r--r-- | source/blender/blenlib/BLI_system.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/source/blender/blenlib/BLI_system.h b/source/blender/blenlib/BLI_system.h index 0d5b2e6e2df..2e5e07d8407 100644 --- a/source/blender/blenlib/BLI_system.h +++ b/source/blender/blenlib/BLI_system.h @@ -30,7 +30,7 @@ int BLI_cpu_support_sse2(void); int BLI_cpu_support_sse41(void); void BLI_system_backtrace(FILE *fp); -/* Get CPU brand, result is to be MEM_freeN()-ed. */ +/** Get CPU brand, result is to be MEM_freeN()-ed. */ char *BLI_cpu_brand_string(void); /** @@ -45,15 +45,19 @@ char *BLI_cpu_brand_string(void); */ void BLI_hostname_get(char *buffer, size_t bufsize); -/* Get maximum addressable memory in megabytes. */ +/** Get maximum addressable memory in megabytes. */ size_t BLI_system_memory_max_in_megabytes(void); +/** Get maximum addressable memory in megabytes (clamped to #INT_MAX). */ int BLI_system_memory_max_in_megabytes_int(void); /* For `getpid`. */ #ifdef WIN32 # define BLI_SYSTEM_PID_H <process.h> -/* void* since we really do not want to drag Windows.h in to get the proper typedef. */ +/** + * \note Use `void *` for `exception` since we really do not want to drag Windows.h + * in to get the proper `typedef`. + */ void BLI_windows_handle_exception(void *exception); #else |