From 07b7c243da70c9bf921a04008af27a47f799ef56 Mon Sep 17 00:00:00 2001 From: Tobias Ulmer Date: Thu, 24 Jan 2013 14:57:14 +0100 Subject: [PATCH] Convert locate_project_root() documentation to ldoc. Signed-off-by: Tobias Ulmer --- generic/e2lib.lua | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/generic/e2lib.lua b/generic/e2lib.lua index 1f2af8e..ee756b6 100644 --- 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") -- 2.39.5