From 8a6f7682d5e1498c45425f2725c90bbbcc34054c Mon Sep 17 00:00:00 2001 From: mitchell <70453897+667e-11@users.noreply.github.com> Date: Sun, 20 Mar 2011 21:33:13 -0400 Subject: Add module field doc to Lua module apidoc. --- modules/lua/lua.luadoc | 154 +++++++++++++++++++++---------------------------- 1 file changed, 65 insertions(+), 89 deletions(-) (limited to 'modules/lua/lua.luadoc') diff --git a/modules/lua/lua.luadoc b/modules/lua/lua.luadoc index 715d4a3f..b0602cc7 100644 --- a/modules/lua/lua.luadoc +++ b/modules/lua/lua.luadoc @@ -40,13 +40,10 @@ function dofile(filename) end -- addition of error position information to the message. function error(message [, level]) end ---- --- A global variable (not a function) that holds the global environment --- (that is, `_G._G = _G`). Lua itself does not use this variable; changing --- its value does not affect any environment, nor vice-versa. (Use `setfenv` --- to change environments.) --- function _G end --- * `_G._G`: _G._G +-- * `_G._G`: A global variable (not a function) that holds the global +-- environment (that is, `_G._G = _G`). Lua itself does not use this variable; +-- changing its value does not affect any environment, nor vice-versa. (Use +-- `setfenv` to change environments.) --- -- Returns the current environment in use by the function. @@ -209,12 +206,9 @@ function type(v) end -- defined by the length operator (see §2.5.5). function unpack(list [, i [, j]]) end ---- --- A global variable (not a function) that holds a string containing the --- current interpreter version. The current contents of this variable is --- "`Lua 5.1`". --- function _VERSION end --- * `_G._VERSION`: _G._VERSION +-- * `_G._VERSION`: A global variable (not a function) that holds a string +-- containing the current interpreter version. The current contents of this +-- variable is "`Lua 5.1`". --- -- This function is similar to `pcall`, except that you can set a new @@ -316,61 +310,54 @@ function module(name [, ···]) end -- any loader for the module, then `require` signals an error. function require(modname) end ---- --- The path used by `require` to search for a C loader. --- Lua initializes the C path `package.cpath` in the same way it initializes --- the Lua path `package.path`, using the environment variable `LUA_CPATH` --- or a default path defined in `luaconf.h`. --- function package.cpath end --- * `package.cpath`: package.cpath - ---- --- A table used by `require` to control which modules are already --- loaded. When you require a module `modname` and `package.loaded[modname]` --- is not false, `require` simply returns the value stored there. --- function package.loaded end --- * `package.loaded`: package.loaded - ---- --- A table used by `require` to control how to load modules. --- Each entry in this table is a *searcher function*. When looking for a module, --- `require` calls each of these searchers in ascending order, with the module --- name (the argument given to `require`) as its sole parameter. The function --- can return another function (the module *loader*) or a string explaining --- why it did not find that module (or nil if it has nothing to say). Lua --- initializes this table with four functions. --- The first searcher simply looks for a loader in the `package.preload` table. --- The second searcher looks for a loader as a Lua library, using the path --- stored at `package.path`. A path is a sequence of *templates* separated by --- semicolons. For each template, the searcher will change each interrogation --- mark in the template by `filename`, which is the module name with each dot --- replaced by a "directory separator" (such as "`/`" in Unix); then it will --- try to open the resulting file name. So, for instance, if the Lua path is --- the string --- "./?.lua;./?.lc;/usr/local/?/init.lua" --- the search for a Lua file for module `foo` will try to open the files --- `./foo.lua`, `./foo.lc`, and `/usr/local/foo/init.lua`, in that order. --- The third searcher looks for a loader as a C library, using the path given --- by the variable `package.cpath`. For instance, if the C path is the string --- "./?.so;./?.dll;/usr/local/?/init.so" --- the searcher for module `foo` will try to open the files `./foo.so`, --- `./foo.dll`, and `/usr/local/foo/init.so`, in that order. Once it finds --- a C library, this searcher first uses a dynamic link facility to link the --- application with the library. Then it tries to find a C function inside the --- library to be used as the loader. The name of this C function is the string --- "`luaopen_`" concatenated with a copy of the module name where each dot --- is replaced by an underscore. Moreover, if the module name has a hyphen, --- its prefix up to (and including) the first hyphen is removed. For instance, --- if the module name is `a.v1-b.c`, the function name will be `luaopen_b_c`. --- The fourth searcher tries an *all-in-one loader*. It searches the C --- path for a library for the root name of the given module. For instance, --- when requiring `a.b.c`, it will search for a C library for `a`. If found, --- it looks into it for an open function for the submodule; in our example, --- that would be `luaopen_a_b_c`. With this facility, a package can pack --- several C submodules into one single library, with each submodule keeping --- its original open function. --- function package.loaders end --- * `package.loaders`: package.loaders +-- * `package.cpath`: The path used by `require` to search for a C loader. +-- Lua initializes the C path `package.cpath` in the same way it initializes +-- the Lua path `package.path`, using the environment variable `LUA_CPATH` +-- or a default path defined in `luaconf.h`. + +-- * `package.loaded`: A table used by `require` to control which modules are +-- already loaded. When you require a module `modname` and +-- `package.loaded[modname]` is not false, `require` simply returns the value +-- stored there. + +-- * `package.loaders`: A table used by `require` to control how to load +-- modules. Each entry in this table is a *searcher function*. When looking +-- for a module, `require` calls each of these searchers in ascending order, +-- with the module name (the argument given to `require`) as its sole +-- parameter. The function can return another function (the module *loader*) +-- or a string explaining why it did not find that module (or nil if it has +-- nothing to say). Lua initializes this table with four functions. +-- The first searcher simply looks for a loader in the `package.preload` +-- table. +-- The second searcher looks for a loader as a Lua library, using the path +-- stored at `package.path`. A path is a sequence of *templates* separated by +-- semicolons. For each template, the searcher will change each interrogation +-- mark in the template by `filename`, which is the module name with each dot +-- replaced by a "directory separator" (such as "`/`" in Unix); then it will +-- try to open the resulting file name. So, for instance, if the Lua path is +-- the string +-- "./?.lua;./?.lc;/usr/local/?/init.lua" +-- the search for a Lua file for module `foo` will try to open the files +-- `./foo.lua`, `./foo.lc`, and `/usr/local/foo/init.lua`, in that order. +-- The third searcher looks for a loader as a C library, using the path given +-- by the variable `package.cpath`. For instance, if the C path is the string +-- "./?.so;./?.dll;/usr/local/?/init.so" +-- the searcher for module `foo` will try to open the files `./foo.so`, +-- `./foo.dll`, and `/usr/local/foo/init.so`, in that order. Once it finds +-- a C library, this searcher first uses a dynamic link facility to link the +-- application with the library. Then it tries to find a C function inside the +-- library to be used as the loader. The name of this C function is the string +-- "`luaopen_`" concatenated with a copy of the module name where each dot +-- is replaced by an underscore. Moreover, if the module name has a hyphen, +-- its prefix up to (and including) the first hyphen is removed. For instance, +-- if the module name is `a.v1-b.c`, the function name will be `luaopen_b_c`. +-- The fourth searcher tries an *all-in-one loader*. It searches the C +-- path for a library for the root name of the given module. For instance, +-- when requiring `a.b.c`, it will search for a C library for `a`. If found, +-- it looks into it for an open function for the submodule; in our example, +-- that would be `luaopen_a_b_c`. With this facility, a package can pack +-- several C submodules into one single library, with each submodule keeping +-- its original open function. --- -- Dynamically links the host program with the C library `libname`. Inside @@ -387,19 +374,14 @@ function require(modname) end -- systems that support the `dlfcn` standard). function package.loadlib(libname, funcname) end ---- --- The path used by `require` to search for a Lua loader. --- At start-up, Lua initializes this variable with the value of the environment --- variable `LUA_PATH` or with a default path defined in `luaconf.h`, if --- the environment variable is not defined. Any "`;;`" in the value of the --- environment variable is replaced by the default path. --- function package.path end --- * `package.path`: package.path +-- * `package.path`: The path used by `require` to search for a Lua loader. +-- At start-up, Lua initializes this variable with the value of the +-- environment variable `LUA_PATH` or with a default path defined in +-- `luaconf.h`, if the environment variable is not defined. Any "`;;`" in the +-- value of the environment variable is replaced by the default path. ---- --- A table to store loaders for specific modules (see `require`). --- function package.preload end --- * `package.preload`: package.preload +-- * `package.preload`: A table to store loaders for specific modules (see +-- `require`). --- -- Sets a metatable for `module` with its `__index` field referring to the @@ -657,11 +639,8 @@ function math.fmod(x, y) end -- absolute value of `m` is in the range *[0.5, 1)* (or zero when `x` is zero). function math.frexp(x) end ---- --- The value `HUGE_VAL`, a value larger than or equal to any other --- numerical value. --- function math.huge end --- * `math.HUGE_VAL`: math.HUGE_VAL +-- * `math.HUGE_VAL`: The value `HUGE_VAL`, a value larger than or equal to any +-- other numerical value. --- -- Returns *m2^e* (`e` should be an integer). @@ -688,10 +667,7 @@ function math.min(x, ···) end -- `x`. function math.modf(x) end ---- --- The value of *pi*. --- function math.pi end --- * `math.pi`: math.pi +-- * `math.pi`: The value of *pi*. --- -- Returns *x^y*. (You can also use the expression `x^y` to compute this -- cgit v1.2.3