]> git.e2factory.org Git - e2factory.git/commitdiff
correct LDoc comments
authorTobias Ulmer <tu@emlix.com>
Wed, 8 Mar 2017 16:46:29 +0000 (17:46 +0100)
committerTobias Ulmer <tu@emlix.com>
Wed, 8 Mar 2017 16:46:29 +0000 (17:46 +0100)
Signed-off-by: Tobias Ulmer <tu@emlix.com>
generic/e2lib.lua
local/e2tool.lua
plugins/gitrepo.lua

index ebfc703b667c0e55d1e4cb7fd57dd05801e7e3f5..b895e19d706b7e789e9e2cbaa0c08d4605244f2b 100644 (file)
@@ -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)
index 5259b1e29de42eb615ec66cbe537ee0fbe9314c3..9cd587c683e12ee152c747f916ef36da855eda38 100644 (file)
@@ -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
index f64f390b38092465e033ad6e8028e98037529db5..bc3eb0dae3a5e6a79567cf7c8ca940050a1bffaa 100644 (file)
@@ -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)