mirror of
https://github.com/zeek/zeek.git
synced 2025-10-13 03:58:20 +00:00
9e49703087
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".
116 lines
2.4 KiB
ReStructuredText
116 lines
2.4 KiB
ReStructuredText
.. Automatically generated. Do not edit.
|
|
|
|
:tocdepth: 3
|
|
|
|
autogen-reST-enums.bro
|
|
======================
|
|
|
|
|
|
|
|
|
|
:Source File: :download:`autogen-reST-enums.bro`
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Options
|
|
#######
|
|
==================================================================== ======================================================================
|
|
:bro:id:`test_enum_option`: :bro:type:`TestEnum1` :bro:attr:`&redef` this should reference the TestEnum1 type and not a generic "enum" type
|
|
==================================================================== ======================================================================
|
|
|
|
Types
|
|
#####
|
|
======================================= ======================================
|
|
:bro:type:`TestEnum1`: :bro:type:`enum` There's tons of ways an enum can look.
|
|
|
|
:bro:type:`TestEnum2`: :bro:type:`enum` The final comma is optional
|
|
======================================= ======================================
|
|
|
|
Redefinitions
|
|
#############
|
|
======================================= =======================
|
|
:bro:type:`TestEnum1`: :bro:type:`enum` redefs should also work
|
|
|
|
:bro:type:`TestEnum1`: :bro:type:`enum` now with a comma
|
|
======================================= =======================
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Options
|
|
#######
|
|
.. bro:id:: test_enum_option
|
|
|
|
:Type: :bro:type:`TestEnum1`
|
|
:Attributes: :bro:attr:`&redef`
|
|
:Default: ``ONE``
|
|
|
|
this should reference the TestEnum1 type and not a generic "enum" type
|
|
|
|
Types
|
|
#####
|
|
.. bro:type:: TestEnum1
|
|
|
|
:Type: :bro:type:`enum`
|
|
|
|
.. bro:enum:: ONE TestEnum1
|
|
|
|
like this
|
|
|
|
.. bro:enum:: TWO TestEnum1
|
|
|
|
or like this
|
|
|
|
.. bro:enum:: THREE TestEnum1
|
|
|
|
multiple
|
|
comments
|
|
and even
|
|
more comments
|
|
|
|
There's tons of ways an enum can look...
|
|
|
|
.. bro:type:: TestEnum2
|
|
|
|
:Type: :bro:type:`enum`
|
|
|
|
.. bro:enum:: A TestEnum2
|
|
|
|
like this
|
|
|
|
.. bro:enum:: B TestEnum2
|
|
|
|
or like this
|
|
|
|
.. bro:enum:: C TestEnum2
|
|
|
|
multiple
|
|
comments
|
|
and even
|
|
more comments
|
|
|
|
The final comma is optional
|
|
|
|
Redefinitions
|
|
#############
|
|
:bro:type:`TestEnum1`
|
|
|
|
:Type: :bro:type:`enum`
|
|
|
|
.. bro:enum:: FOUR TestEnum1
|
|
|
|
adding another
|
|
value
|
|
|
|
redefs should also work
|
|
|
|
:bro:type:`TestEnum1`
|
|
|
|
:Type: :bro:type:`enum`
|
|
|
|
.. bro:enum:: FIVE TestEnum1
|
|
|
|
adding another
|
|
value
|
|
|
|
now with a comma
|
|
|