improve more modules commentscomments

6 files changed, 43 insertions, 1 deletions

diff --git a/xmake/modules/private/action/require/impl/actions/check.lua b/xmake/modules/private/action/require/impl/actions/check.lua
index d6143fcfa..2bd840d75 100644
--- a/xmake/modules/private/action/require/impl/actions/check.lua
+++ b/xmake/modules/private/action/require/impl/actions/check.lua
@@ -22,7 +22,11 @@
 import("core.base.option")
 import("core.project.config")
 
--- check the given package
+-- check the package after installation
+--
+-- @param package  the package instance
+-- @param opt      the options
+--
 function main(package, opt)
     opt = opt or {}
 
diff --git a/xmake/modules/private/action/require/impl/actions/download.lua b/xmake/modules/private/action/require/impl/actions/download.lua
index 84c8d85be..5930b3cbb 100644
--- a/xmake/modules/private/action/require/impl/actions/download.lua
+++ b/xmake/modules/private/action/require/impl/actions/download.lua
@@ -323,6 +323,16 @@ function _urls(package)
 end
 
 -- download the given package
+-- download the package source
+--
+-- @param package  the package instance
+-- @param opt      the options
+--
+-- download the package source
+--
+-- @param package  the package instance
+-- @param opt      the options
+--
 function main(package, opt)
     opt = opt or {}
 
diff --git a/xmake/modules/private/action/require/impl/actions/download_resources.lua b/xmake/modules/private/action/require/impl/actions/download_resources.lua
index 30e7f9146..c185d25b0 100644
--- a/xmake/modules/private/action/require/impl/actions/download_resources.lua
+++ b/xmake/modules/private/action/require/impl/actions/download_resources.lua
@@ -164,6 +164,14 @@ function _download(package, resource_name, resource_url, resource_hash)
 end
 
 -- download all resources of the given package
+-- download the package resources
+--
+-- @param package  the package instance
+--
+-- download the package resources
+--
+-- @param package  the package instance
+--
 function main(package)
 
     -- we don't need to download it if we use the precompiled artifacts to install package
diff --git a/xmake/modules/private/action/require/impl/actions/install.lua b/xmake/modules/private/action/require/impl/actions/install.lua
index 94f8007b3..3789573b6 100644
--- a/xmake/modules/private/action/require/impl/actions/install.lua
+++ b/xmake/modules/private/action/require/impl/actions/install.lua
@@ -436,6 +436,10 @@ function _get_package_tipname(package)
     return package_tipname
 end
 
+-- install the package
+--
+-- @param package  the package instance
+--
 function main(package)
     local oldir = _enter_workdir(package)
 
diff --git a/xmake/modules/private/action/require/impl/actions/patch_sources.lua b/xmake/modules/private/action/require/impl/actions/patch_sources.lua
index 81f506420..6c18b69b1 100644
--- a/xmake/modules/private/action/require/impl/actions/patch_sources.lua
+++ b/xmake/modules/private/action/require/impl/actions/patch_sources.lua
@@ -143,6 +143,14 @@ function _patch(package, patchinfo)
 end
 
 -- patch the given package
+-- patch the package sources
+--
+-- @param package  the package instance
+--
+-- patch the package sources
+--
+-- @param package  the package instance
+--
 function main(package)
 
     -- we don't need to patch it if we use the precompiled artifacts to install package
diff --git a/xmake/modules/private/action/require/impl/actions/test.lua b/xmake/modules/private/action/require/impl/actions/test.lua
index f30d5febe..d07e5ece3 100644
--- a/xmake/modules/private/action/require/impl/actions/test.lua
+++ b/xmake/modules/private/action/require/impl/actions/test.lua
@@ -23,6 +23,14 @@ import("core.base.option")
 import("private.action.require.impl.utils.filter")
 
 -- test the given package
+-- test the installed package
+--
+-- @param package  the package instance
+--
+-- test the installed package
+--
+-- @param package  the package instance
+--
 function main(package)
 
     -- enter the test directory