doc: EDC reference: Add specific doc for group.data

Group.data does not support "file", only "item". This doc
explains that.

Should Group.Data support file instead?
This commit is contained in:
Jean-Philippe Andre 2015-06-26 11:48:57 +09:00
parent b676dcf998
commit a31222ae6f
1 changed files with 30 additions and 1 deletions

View File

@ -80,7 +80,7 @@
* <ul>
* <li>@ref sec_collections_group_script "Script"</li>
* <li>@ref sec_collections_group_limits "Limits"</li>
* <li>@ref sec_toplevel_data "Data"</li>
* <li>@ref sec_collections_group_data "Data"</li>
* <li>@ref sec_collections_group_parts "Parts"</li>
* <ul>
* <li>@ref sec_collections_group_parts_part "Part"</li>
@ -4229,6 +4229,35 @@ ob_collections_group_lua_script(void)
}
}
/** @edcsubsection{collections_group_data,
* Group.Data} */
/**
@page edcref
@block
data
@context
data {
item: "key" "value";
..
}
@description
The "data" block is used to pass arbitrary parameters from the theme to
the application. Unlike the toplevel data block, this block Group.Data
can only store inline items (not files).
See also the toplevel @ref sec_toplevel_data "Data" section.
@endblock
@property
item
@parameters
[parameter name] [parameter value]
@effect
Defines a new parameter, the value will be the string specified next to
it.
@endproperty
*/
static void
st_collections_group_data_item(void)
{