From: Tobias Ulmer <tu@emlix.com>
Date: Wed, 8 Mar 2017 16:46:29 +0000 (+0100)
Subject: correct LDoc comments
X-Git-Tag: e2factory-2.3.17~1
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=16d4892ddfcfbb682457f456f62a42e37a21cfb8;p=e2factory.git

correct LDoc comments

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

diff --git a/generic/e2lib.lua b/generic/e2lib.lua
index ebfc703..b895e19 100644
--- a/generic/e2lib.lua
+++ b/generic/e2lib.lua
@@ -328,8 +328,8 @@ function e2lib.getpid()
 end
 
 --- Set process group ID.
--- @pid process id
--- @pgid process group id
+-- @param pid process id
+-- @param pgid process group id
 -- @raise error on failure.
 function e2lib.setpgid(pid, pgid)
     return le2lib.setpgid(pid, pgid)
diff --git a/local/e2tool.lua b/local/e2tool.lua
index 5259b1e..9cd587c 100644
--- a/local/e2tool.lua
+++ b/local/e2tool.lua
@@ -799,7 +799,7 @@ end
 
 --- Compare global interface version and complain if we're not compatible.
 -- @return True on success, false on error.
--- @Error object on failure.
+-- @return Error object on failure.
 local function check_global_interface_version()
     local rc, re, e
     local givf, line, supported
diff --git a/plugins/gitrepo.lua b/plugins/gitrepo.lua
index f64f390..bc3eb0d 100644
--- a/plugins/gitrepo.lua
+++ b/plugins/gitrepo.lua
@@ -518,7 +518,7 @@ end
 --- Archives the source and prepares the necessary files outside the archive
 -- @param src source object
 -- @param sourceset string, should be "tag" "branch" or "working copy", in order for it to work
--- @param the directory where the sources are and where the archive is to be created
+-- @param directory the directory where the sources are and where the archive is to be created
 -- @return True on success, false on error.
 -- @return Error object on failure
 local function gitrepo_to_result(src, sourceset, directory)