Signed-off-by: Stefan Weil <sw@weilnetz.de>
-- Processes a parameter documentation.
-- @param tag String with the name of the tag (it must be "param" always).
-- @param block Table with previous information about the block.
-- Processes a parameter documentation.
-- @param tag String with the name of the tag (it must be "param" always).
-- @param block Table with previous information about the block.
--- @param text String with the current line beeing processed.
+-- @param text String with the current line being processed.
local function param (tag, block, text)
block[tag] = block[tag] or {}
local function param (tag, block, text)
block[tag] = block[tag] or {}
module "luadoc.util"
-------------------------------------------------------------------------------
module "luadoc.util"
-------------------------------------------------------------------------------
--- Removes spaces from the begining and end of a given string
+-- Removes spaces from the beginning and end of a given string
-- @param s string to be trimmed
-- @return trimmed string
-- @param s string to be trimmed
-- @return trimmed string
end
-------------------------------------------------------------------------------
end
-------------------------------------------------------------------------------
--- Removes spaces from the begining and end of a given string, considering the
+-- Removes spaces from the beginning and end of a given string, considering the
-- string is inside a lua comment.
-- @param s string to be trimmed
-- @return trimmed string
-- string is inside a lua comment.
-- @param s string to be trimmed
-- @return trimmed string
-- Split text into a list consisting of the strings in text,
-- separated by strings matching delim (which may be a pattern).
-- @param delim if delim is "" then action is the same as %s+ except that
-- Split text into a list consisting of the strings in text,
-- separated by strings matching delim (which may be a pattern).
-- @param delim if delim is "" then action is the same as %s+ except that
--- field 1 may be preceeded by leading whitespace
+-- field 1 may be preceded by leading whitespace
-- @usage split(",%s*", "Anna, Bob, Charlie,Dolores")
-- @usage split(""," x y") gives {"x","y"}
-- @usage split("%s+"," x y") gives {"", "x","y"}
-- @usage split(",%s*", "Anna, Bob, Charlie,Dolores")
-- @usage split(""," x y") gives {"x","y"}
-- @usage split("%s+"," x y") gives {"", "x","y"}