summaryrefslogtreecommitdiff
path: root/xmake/core/base/debugger.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/base/debugger.lua
parente23dc968df5fa84e24e98a7fff903e40a12d6624 (diff)
update more comments
Diffstat (limited to 'xmake/core/base/debugger.lua')
-rw-r--r--xmake/core/base/debugger.lua12
1 files changed, 9 insertions, 3 deletions
diff --git a/xmake/core/base/debugger.lua b/xmake/core/base/debugger.lua
index f62871482..f9a5e451e 100644
--- a/xmake/core/base/debugger.lua
+++ b/xmake/core/base/debugger.lua
@@ -47,14 +47,17 @@ function debugger:_start_emmylua_debugger()
return true
end
--- start debugging
+-- start the debugger (attach to IDE)
function debugger:start()
if self:has_emmylua() then
return self:_start_emmylua_debugger()
end
end
--- has emmylua debugger?
+-- has EmmyLua debugger available?
+--
+-- @return true if available
+--
function debugger:has_emmylua()
local debugger_libfile = os.getenv("EMMYLUA_DEBUGGER")
if debugger_libfile and os.isfile(debugger_libfile) then
@@ -62,7 +65,10 @@ function debugger:has_emmylua()
end
end
--- debugger is enabled?
+-- is the debugger enabled?
+--
+-- @return true if enabled via --debugger option
+--
function debugger:enabled()
return self:has_emmylua()
end