From: Tobias Ulmer <tu@emlix.com>
Date: Thu, 22 Sep 2016 14:00:13 +0000 (+0200)
Subject: e2build: document
X-Git-Tag: e2factory-2.3.15rc1~86
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=7de8df134c383dac52fab9dbcbc5e4b4144fd4fb;p=e2factory.git

e2build: document

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

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())