zeek/testing/btest/doc/autogen-reST-enums.bro
Jon Siwek 9e49703087 Improve auto-generated enum documentation.
The names of enum types are tracked so that variables holding a value
of a given enum type can generate a reference to it instead of just
listing the type as a generic "enum".
2012-11-15 16:54:33 -06:00

39 lines
784 B
Text

# @TEST-EXEC: bro --doc-scripts %INPUT
# @TEST-EXEC: btest-diff autogen-reST-enums.rst
## There's tons of ways an enum can look...
type TestEnum1: enum {
## like this
ONE,
TWO, ##< or like this
## multiple
## comments
THREE, ##< and even
##< more comments
};
## The final comma is optional
type TestEnum2: enum {
## like this
A,
B, ##< or like this
## multiple
## comments
C ##< and even
##< more comments
};
## redefs should also work
redef enum TestEnum1 += {
## adding another
FOUR ##< value
};
## now with a comma
redef enum TestEnum1 += {
## adding another
FIVE, ##< value
};
## this should reference the TestEnum1 type and not a generic "enum" type
const test_enum_option = ONE &redef;