summaryrefslogtreecommitdiff
path: root/xmake/modules/lib/detect/features.lua
diff options
context:
space:
mode:
authorruki <[email protected]>2026-03-30 23:59:50 +0800
committerruki <[email protected]>2026-03-30 23:59:50 +0800
commit90f05f17328ccac2764fb80895ef72c4510d91f6 (patch)
treed32f59d711b5ae9597ccf29f448b6b2c0322c8fc /xmake/modules/lib/detect/features.lua
parent701d59c83a64bf5aa73f2bc386a0cdba087349c4 (diff)
add more comments
Diffstat (limited to 'xmake/modules/lib/detect/features.lua')
-rw-r--r--xmake/modules/lib/detect/features.lua6
1 files changed, 6 insertions, 0 deletions
diff --git a/xmake/modules/lib/detect/features.lua b/xmake/modules/lib/detect/features.lua
index 997acd2a1..4f0463181 100644
--- a/xmake/modules/lib/detect/features.lua
+++ b/xmake/modules/lib/detect/features.lua
@@ -35,6 +35,12 @@ import("core.base.scheduler")
-- local features = features("clang", {flags = {"-g", "-O0"}, envs = {PATH = ""}})
-- @endcode
--
+-- get all supported features of the given tool
+--
+-- @param name the tool name, e.g. "clang", "gcc"
+-- @param opt the options, e.g. {program = "", flags = {}}
+-- @return the features table, e.g. {cxx_constexpr = true}
+--
function main(name, opt)
-- init options