Improve documentation of table and set types

Add a list of the types that are not allowed to be the index type
of a table or set.
This commit is contained in:
Daniel Thayer 2015-08-17 16:24:02 -05:00
parent 7b6ab180b6
commit c6dec18e2b

View file

@ -340,15 +340,18 @@ Here is a more detailed description of each type:
table [ type^+ ] of type table [ type^+ ] of type
where *type^+* is one or more types, separated by commas. where *type^+* is one or more types, separated by commas. The
For example: index type cannot be any of the following types: pattern, table, set,
vector, file, opaque, any.
Here is an example of declaring a table indexed by "count" values
and yielding "string" values:
.. code:: bro .. code:: bro
global a: table[count] of string; global a: table[count] of string;
declares a table indexed by "count" values and yielding The yield type can also be more complex:
"string" values. The yield type can also be more complex:
.. code:: bro .. code:: bro
@ -441,7 +444,9 @@ Here is a more detailed description of each type:
set [ type^+ ] set [ type^+ ]
where *type^+* is one or more types separated by commas. where *type^+* is one or more types separated by commas. The
index type cannot be any of the following types: pattern, table, set,
vector, file, opaque, any.
Sets can be initialized by listing elements enclosed by curly braces: Sets can be initialized by listing elements enclosed by curly braces: