From e8d7d0dfdcb0b3076ed2c26a1324f77d188e43c7 Mon Sep 17 00:00:00 2001
From: ruki <waruqi@gmail.com>
Date: Mon, 30 Mar 2026 23:11:44 +0800
Subject: update comments

---
 xmake/core/base/process.lua | 25 +++++++++++++++++++++----
 1 file changed, 21 insertions(+), 4 deletions(-)

(limited to 'xmake/core/base/process.lua')

diff --git a/xmake/core/base/process.lua b/xmake/core/base/process.lua
index 692a6360f..35b0b15b7 100644
--- a/xmake/core/base/process.lua
+++ b/xmake/core/base/process.lua
@@ -51,6 +51,9 @@ function _subprocess.new(program, proc)
 end
 
 -- get the process name
+--
+-- @return      the process name string
+--
 function _subprocess:name()
     if not self._NAME then
         self._NAME = path.filename(self:program())
@@ -58,7 +61,10 @@ function _subprocess:name()
     return self._NAME
 end
 
--- get the process program
+-- get the process program path
+--
+-- @return      the program path string
+--
 function _subprocess:program()
     return self._PROGRAM
 end
@@ -101,7 +107,10 @@ function _subprocess:wait(timeout)
     return result, status_or_errors
 end
 
--- kill subprocess
+-- kill the subprocess
+--
+-- @return      true on success
+--
 function _subprocess:kill()
 
     -- ensure opened
@@ -115,7 +124,10 @@ function _subprocess:kill()
     return true
 end
 
--- close subprocess
+-- close the subprocess and release resources
+--
+-- @return      true on success
+--
 function _subprocess:close()
 
     -- ensure opened
@@ -305,7 +317,12 @@ function process._get_missing_dlls(program)
     return missing
 end
 
--- get process exit errors
+-- get process exit error message
+--
+-- @param program    the program path
+-- @param exitcode   the exit code
+-- @return          the error message string, or nil
+--
 function process.get_exit_errors(program, exitcode)
     local errors
     if os.is_host("windows") then
-- 
cgit v1.3.1