summaryrefslogtreecommitdiff
path: root/xmake/core/project/option.lua
diff options
context:
space:
mode:
authorruki <[email protected]>2026-03-30 23:51:59 +0800
committerruki <[email protected]>2026-03-30 23:51:59 +0800
commit701d59c83a64bf5aa73f2bc386a0cdba087349c4 (patch)
tree85de317c9904b4aa9e818cbef5615ed2cfad28be /xmake/core/project/option.lua
parente23dc968df5fa84e24e98a7fff903e40a12d6624 (diff)
update more comments
Diffstat (limited to 'xmake/core/project/option.lua')
-rw-r--r--xmake/core/project/option.lua22
1 files changed, 19 insertions, 3 deletions
diff --git a/xmake/core/project/option.lua b/xmake/core/project/option.lua
index f754b4efc..62687a106 100644
--- a/xmake/core/project/option.lua
+++ b/xmake/core/project/option.lua
@@ -388,11 +388,17 @@ function _instance:check()
end
-- get the option value
+--
+-- @return the option value
+--
function _instance:value()
return config.get(self:fullname())
end
-- set the option value
+--
+-- @param value the value to set
+--
function _instance:set_value(value)
config.set(self:fullname(), value)
self:_save()
@@ -404,7 +410,10 @@ function _instance:clear()
self:_clear()
end
--- this option is enabled?
+-- is this option enabled?
+--
+-- @return true if enabled
+--
function _instance:enabled()
return config.get(self:fullname())
end
@@ -437,12 +446,19 @@ function _instance:info()
return self._INFO:info()
end
--- get the type: option
+-- get the instance type
+--
+-- @return "option"
+--
function _instance:type()
return "option"
end
--- get the option info
+-- get the option info value
+--
+-- @param name the info name
+-- @return the info value
+--
function _instance:get(name)
return self._INFO:get(name)
end