summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorruki <[email protected]>2022-10-20 22:36:41 +0800
committerruki <[email protected]>2022-10-20 22:36:41 +0800
commit2183a9d1ac3d63351a36b5a855c7fce02405d374 (patch)
treefcbe1bf1b64773fc8d62d261ea025d8a7437036b
parentf873fb08773931668b2abe77f4f29b35f2ec0edb (diff)
add some comments
-rw-r--r--xmake/core/package/package.lua18
1 files changed, 18 insertions, 0 deletions
diff --git a/xmake/core/package/package.lua b/xmake/core/package/package.lua
index c52e14c7f..224a8fa37 100644
--- a/xmake/core/package/package.lua
+++ b/xmake/core/package/package.lua
@@ -1810,6 +1810,9 @@ function _instance:component(name)
end
-- get package components
+--
+-- .e.g. add_components("graphics", "windows")
+--
function _instance:components()
local components = self._COMPONENTS
if not components then
@@ -1823,6 +1826,21 @@ function _instance:components()
end
-- get package dependencies of components
+--
+-- @see https://github.com/xmake-io/xmake/issues/2636#issuecomment-1284787681
+--
+-- @code
+-- add_components("graphics", {deps = "window"})
+-- @endcode
+--
+-- or
+--
+-- @code
+-- on_component(function (package, component))
+-- component:add("deps", "window")
+-- end)
+-- @endcode
+--
function _instance:components_deps()
local components_deps = self._COMPONENTS_DEPS
if not components_deps then