Document e2tool.dsort()

Signed-off-by: Tobias Ulmer <tu@emlix.com>

diff --git a/local/e2tool.lua b/local/e2tool.lua
index f9c7f677056988c29f9f30b9f6ebb641248866ba..fc2589d8bab3ea0771bcd954e63db7b24c497ee1 100644 (file)
--- a/local/e2tool.lua
+++ b/local/e2tool.lua
@@ -1687,11 +1687,11 @@ function e2tool.dlist_recursive(info, result)
     return t
 end
 
----   e2tool.dsort(INFO) -> ARRAY.
---
---     Returns an array with the names of all results of the project specified
---     by INFO, topologically sorted according to the projects dependency
---     information.
+--- Calls dlist_recursive() with the default results vector of the project.
+-- @param info Info table.
+-- @return Vector of results in topological order, or false on error.
+-- @return Error object on failure.
+-- @see e2tool.dlist_recursive
 function e2tool.dsort(info)
     return e2tool.dlist_recursive(info, info.project.default_results)
 end