Convert locate_project_root() documentation to ldoc.

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

diff --git a/generic/e2lib.lua b/generic/e2lib.lua
index 1f2af8e5f6c476b55f13409b6eb339cb2a290295..ee756b63e47520de16b2e0a7a8d912a4d5441c23 100644 (file)
--- a/generic/e2lib.lua
+++ b/generic/e2lib.lua
@@ -1201,13 +1201,13 @@ function e2lib.dofile2(path, gtable)
     return true, nil
 end
 
---   locate_project_root([PATH]) -> PATH | nil
---
---     Locates the root directory of current project. If PATH is not given,
---     then the current working directory is taken as the base directory from
---     where to start.
---
-
+--- Locates the root directory of the current project. If path is not given,
+-- then the current working directory is taken as the base directory from
+-- where to start.
+-- @param path Project directory (string) or nil.
+-- @return Absolute base project directory or nil on error.
+-- XXX: change nil to false.
+-- @return Error object on failure.
 function e2lib.locate_project_root(path)
     local rc, re
     local e = err.new("checking for project directory failed")