mirror of
https://github.com/zeek/zeek.git
synced 2025-10-04 23:58: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.
58 lines
1.2 KiB
ReStructuredText
58 lines
1.2 KiB
ReStructuredText
.. Automatically generated. Do not edit.
|
|
|
|
:tocdepth: 3
|
|
|
|
autogen-reST-func-params.bro
|
|
============================
|
|
|
|
|
|
|
|
|
|
:Source File: :download:`autogen-reST-func-params.bro`
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Types
|
|
#####
|
|
======================================== =
|
|
:bro:type:`test_rec`: :bro:type:`record`
|
|
======================================== =
|
|
|
|
Functions
|
|
#########
|
|
===================================== ======================================
|
|
:bro:id:`test_func`: :bro:type:`func` This is a global function declaration.
|
|
===================================== ======================================
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Types
|
|
#####
|
|
.. bro:type:: test_rec
|
|
|
|
:Type: :bro:type:`record`
|
|
|
|
field_func: :bro:type:`function` (i: :bro:type:`int`, j: :bro:type:`int`) : :bro:type:`string`
|
|
This is a record field function.
|
|
|
|
:param i: First param.
|
|
:param j: Second param.
|
|
|
|
:returns: A string.
|
|
|
|
Functions
|
|
#########
|
|
.. bro:id:: test_func
|
|
|
|
:Type: :bro:type:`function` (i: :bro:type:`int`, j: :bro:type:`int`) : :bro:type:`string`
|
|
|
|
This is a global function declaration.
|
|
|
|
|
|
:param i: First param.
|
|
|
|
:param j: Second param.
|
|
|
|
|
|
:returns: A string.
|
|
|