From 7de8df134c383dac52fab9dbcbc5e4b4144fd4fb Mon Sep 17 00:00:00 2001 From: Tobias Ulmer Date: Thu, 22 Sep 2016 16:00:13 +0200 Subject: [PATCH] e2build: document Signed-off-by: Tobias Ulmer --- local/e2build.lua | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/local/e2build.lua b/local/e2build.lua index db5547d..c86921d 100644 --- 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()) -- 2.39.5