summaryrefslogtreecommitdiff
path: root/xmake/core/base/memory.lua
diff options
context:
space:
mode:
authorruki <[email protected]>2026-03-26 22:51:05 +0800
committerruki <[email protected]>2026-03-26 22:51:05 +0800
commit6dd2023c43ab4fc46d9bce7599e6875e4ff33957 (patch)
tree2d506776241c397cd09da3c485335ba0e1a369f8 /xmake/core/base/memory.lua
parent4dce664638308306dcd637d0a86808589fb617f6 (diff)
update more comments
Diffstat (limited to 'xmake/core/base/memory.lua')
-rw-r--r--xmake/core/base/memory.lua4
1 files changed, 4 insertions, 0 deletions
diff --git a/xmake/core/base/memory.lua b/xmake/core/base/memory.lua
index ff52658e5..5225a3c8a 100644
--- a/xmake/core/base/memory.lua
+++ b/xmake/core/base/memory.lua
@@ -25,6 +25,10 @@ local memory = memory or {}
local os = require("base/os")
-- get memory info
+--
+-- @param name the specific info name (optional), e.g. "totalsize", "availsize", "usagerate"
+-- @return the memory info table or specific value (sizes in bytes, usagerate in 0.0 ~ 1.0)
+--
function memory.info(name)
local meminfo = memory._MEMINFO
local memtime = memory._MEMTIME