summaryrefslogtreecommitdiff
path: root/xmake/core/base/graph.lua
diff options
context:
space:
mode:
authorruki <[email protected]>2025-03-22 00:43:40 +0800
committerruki <[email protected]>2025-04-08 15:31:55 +0800
commit4a8219cda19cf320330ab7488f53158624c8c393 (patch)
tree7348edfb0b0ea27e3b22dfff89df00f8f8a6798d /xmake/core/base/graph.lua
parent63ed1854ea964fbbe7bc9dbdd8e2c34068dff7de (diff)
update comments
Diffstat (limited to 'xmake/core/base/graph.lua')
-rw-r--r--xmake/core/base/graph.lua19
1 files changed, 19 insertions, 0 deletions
diff --git a/xmake/core/base/graph.lua b/xmake/core/base/graph.lua
index 090d41ade..4be7a2b77 100644
--- a/xmake/core/base/graph.lua
+++ b/xmake/core/base/graph.lua
@@ -142,6 +142,25 @@ end
-- @return array of nodes with zero in-degree, empty when complete
-- @return has_cycle indicates if a cycle was detected
--
+-- @code
+-- dag:partial_topo_sort_reset()
+--
+-- local node, has_cycle
+-- local order_vertices = {}
+-- while true do
+-- node, has_cycle = dag:partial_topo_sort_next()
+-- if node then
+-- table.insert(order_vertices, node)
+-- dag:partial_topo_sort_remove(node)
+-- else
+-- if has_cycle then
+-- -- find cycle
+-- end
+-- break
+-- end
+-- end
+-- @endcode
+--
-- e.g.
--
-- add_edge(a, b) -- a depend on b