How to represent an argument that's a table?

[vadi2]

I have an argument that's a table of values, how can I document it using ldoc? @table seems to be for stand-alone tables.

[keneanung]

I've been using the following:

---
-- Convenience wrapper around `IOE.Core.echo`. This way we don't need to put the module in
--   front of each echo.
-- @string what The text to echo.
-- @tparam {{highlightText=string,highlightType=IOE.Core.HighlightTypes},...} highlights
--   Highlights in `what`.
local echo = function(what, highlights)

[vadi2]

Don't think that worked right for me:

-- @tparam {{highlightText=string,highlightType=IOE.Core.HighlightTypes},...} cons
function Geyser.Label:addChild(cons, container)
    cons = cons or {}

My current and rather contrived workaround is:

--- cons argument for @{Geyser.Label:addChild}
-- @field name a unique name for the label
-- @field height height of the label - specify it as the defaults are huge
-- @field width width of the label - specify it as the defaults are huge
-- @field[opt='LV'] layoutDir specifies in which direction and axis should the labels align, where 2 letters combine into the option: first letter R for right, L for left, T for top, B for bottom, followed by the orientation: V for vertical or H for horizontal. So options are: layoutDir="RV", layoutDir="RH", layoutDir="LV", layoutDir="LH", and so on
-- @field[opt=false] flyOut allows labels to show up when mouse is hovered over
-- @field[opt=''] message initial message to show on the label
-- @field[opt='white'] fgColor optional foreground colour - colour to use for text on the label
-- @field[opt='black'] bgColor optional background colour - colour of the whole label
-- @field[opt=1] fillBg 1 if the background is to be filled, 0 for no background
addChildCons = {
  name = "",
  height = 30,
  width = 70,
  layoutDir = "RV",
  flyOut = true,
  message = "",
  fgColor = "white",
  bgColor = "black",
  fillBig = 1,
}
addChildCons = nil

--- adds a flyout label to an existing label that is marked with nestable=true
--- see http://wiki.mudlet.org/w/Manual:Geyser#Flyout_Labels for examples
-- @tparam table cons see @{addChildCons}
function Geyser.Label:addChild(cons, container)
    cons = cons or {}

[stevedonovan]

It is supported, although not well documented. Look at tests/styles/subparams.lua

-------
-- A function with subfield arguments.
-- @param s string
-- @param opts multibyte encoding options
-- @param opts.charset string
-- @param opts.strict bool
-- @param verbose bool
-- @return its length
function with_options (s,opts,verbose)
end

The other alternative of course, is to document that table separately and use a reference to it.

[vadi2]

Thank you, that works great!

[stevedonovan]

Yeah, I really need to revise the docs and cover all the nice little features.

…

On Sun, Mar 12, 2017 at 12:23 AM, Vadim Peretokin ***@***.***> wrote: Thank you, that works great! — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#265 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AANXDROf9cfET9WRAdrghNxvzgaEErVOks5rkx7OgaJpZM4MTDDh> .

[zhanlangorz]

@stevedonovan But the [opt] flag is not support while use subparams.