mirror of
https://github.com/zeek/zeek.git
synced 2025-10-13 12:08:20 +00:00
3d2dc5f5fc
* origin/topic/script-reference: (50 commits) A few updates for the FAQ. Fixing some doc warnings. Forgot to add protocol identifier support for TLS 1.2 Finished SSL & syslog autodocs. Adding the draft SSL extension type next_protocol_negotiation. Fix some documentation errors. Tweaks. A set of script-reference polishing. fixed a couple typos in comments Add summary documentation to bif files. Add ssl and syslog script documentation Add Conn and DNS protocol script documentation. (fixes #731) Small updates to the default local.bro. Documentation updates for HTTP & IRC scripts. SSH&FTP Documentation updates. Fixing a warning from the documentation generation. This completes framework documentation package 4. Minor notice documentation tweaks. Fix some malformed Broxygen xref roles. Minor doc tweaks to init-bare.bro. ... Conflicts: aux/broccoli aux/broctl src/bro.bif src/strings.bif Includes: - Updated baselines for autodoc tests. - Now excluding stats.bro from external texts, it's not stable.
100 lines
1.7 KiB
ReStructuredText
100 lines
1.7 KiB
ReStructuredText
.. Automatically generated. Do not edit.
|
|
|
|
:tocdepth: 3
|
|
|
|
autogen-reST-enums.bro
|
|
======================
|
|
|
|
|
|
|
|
|
|
:Source File: :download:`autogen-reST-enums.bro`
|
|
|
|
Summary
|
|
~~~~~~~
|
|
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
|
|
~~~~~~~~~~~~~~~~~~
|
|
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
|
|
|