e2build: document

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

diff --git a/local/e2build.lua b/local/e2build.lua
index db5547d3a1df80eb3c8b0135a69955a8f403f152..c86921d91790182e01ad20840c19e39966c05a40 100644 (file)
--- a/local/e2build.lua
+++ b/local/e2build.lua
@@ -77,6 +77,10 @@ function e2build.build_process_class:initialize()
     self:add_step("playground", "enter_playground", self._enter_playground)
 end
 
+--- Build one result.
+--@param res Result object
+--@return True on success, false on error.
+--@return Error object on failure.
 function e2build.build_process_class:build(res)
     assert(res:isInstanceOf(result.basic_result))
     e2lib.logf(3, "building result: %s", res:get_name())