spec: Update specification for Set structure

* Inside a Set object, label is no longer optional
* The "sets" container (Root.sets) will be an array instead
  of an object. They don't need to have an internal key.
  Contrary to Root.params where the key relates to the
  parameter key in wikitext.

Change-Id: Iede29d25cd6ecbcf43970e1e45e60e5aac206a95
This commit is contained in:
Timo Tijhof 2013-05-15 23:34:33 +02:00
parent 6116171d69
commit 0878be5ad9

View file

@ -9,9 +9,9 @@
@property {InterfaceText} [description]
@property {Object} params Contains all parameters.
Keyed by parameter name, contains #Param objects.
@property {Object} sets Groups of parameters that should be used
together. Groups may overlap with each other, though this is not recommended.
Keyed by an internal id, contains #Set objects.
@property {Array} sets List of groups of parameters that should be used
together. A parameter can be in multiple sets. Not every parameter has to be
in a set. The array contains #Set objects.
@structure {Object} Param
@property {InterfaceText} [label] Defaults to key of object in `Root.params`.
@ -31,7 +31,7 @@
overriding the inherited ones.
@structure {Object} Set
@property {InterfaceText} [label] Defaults to key of object in `Root.sets`.
@property {InterfaceText} label Label of this set.
@property {Array} params A subset of the parameter's names that belong to this set.
@structure {string} Type