From 80f6e767c96d77ef0f49ca14eda1d81b4b17dcb3 Mon Sep 17 00:00:00 2001 From: Hisham Muhammad Date: Wed, 20 Jul 2011 11:11:38 -0300 Subject: minor documentation fixes --- src/luarocks/build.lua | 3 +++ src/luarocks/loader.lua | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/luarocks/build.lua b/src/luarocks/build.lua index c2656fef..44f60df8 100644 --- a/src/luarocks/build.lua +++ b/src/luarocks/build.lua @@ -93,6 +93,9 @@ end -- @param rockspec_file string: local or remote filename of a rockspec. -- @param need_to_fetch boolean: true if sources need to be fetched, -- false if the rockspec was obtained from inside a source rock. +-- @param minimal_mode boolean: true if there's no need to fetch, +-- unpack or change dir (this is used by "luarocks make"). Implies +-- need_to_fetch = false. -- @return boolean or (nil, string, [string]): True if succeeded or -- nil and an error message followed by an error code. function build_rockspec(rockspec_file, need_to_fetch, minimal_mode) diff --git a/src/luarocks/loader.lua b/src/luarocks/loader.lua index 3d421632..258c45a2 100644 --- a/src/luarocks/loader.lua +++ b/src/luarocks/loader.lua @@ -37,8 +37,8 @@ end --- Process the dependencies of a package to determine its dependency -- chain for loading modules. --- @parse name string: The name of an installed rock. --- @parse version string: The version of the rock, in string format +-- @param name string: The name of an installed rock. +-- @param version string: The version of the rock, in string format function add_context(name, version) -- assert(type(name) == "string") -- assert(type(version) == "string") -- cgit v1.2.3-55-g6feb