add some comments

1 files changed, 4 insertions, 1 deletions

diff --git a/xmake/actions/build/kinds/object.lua b/xmake/actions/build/kinds/object.lua
index 79c37ffcf..e47fce1ac 100644
--- a/xmake/actions/build/kinds/object.lua
+++ b/xmake/actions/build/kinds/object.lua
@@ -243,7 +243,10 @@ function _build_sourcebatch_groups_for_rules(groups, target, sourcebatches)
     end
 end
 
--- build sourcebatch groups by rule dependencies order
+-- build sourcebatch groups by rule dependencies order, e.g. `add_deps("qt.ui", {order = true})`
+--
+-- @see https://github.com/xmake-io/xmake/issues/2814
+--
 function _build_sourcebatch_groups(target, sourcebatches)
     local groups = {{}}
     _build_sourcebatch_groups_for_target(groups, target, sourcebatches)