mirror of
https://github.com/zeek/zeek.git
synced 2025-10-05 16:18:19 +00:00
2007eeae1b
We're currently rendering parameter descriptions from .bif file into
the .rst as follows:
:cid: The connection identifier.
:aid: The analyzer ID.
Switch this to :param cid: instead so that we can have Sphinx deal with
this as param docfield and group all parameters into a single section.
Currently, having the bare :cid: style causes sphinx to treat it as an
unknown field type, capitalize it and render it.
33 lines
805 B
ReStructuredText
33 lines
805 B
ReStructuredText
### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
|
|
.. zeek:id:: test_func_params_func
|
|
:source-code: <...>/func-params.zeek 11 11
|
|
|
|
:Type: :zeek:type:`function` (i: :zeek:type:`int`, j: :zeek:type:`int`) : :zeek:type:`string`
|
|
|
|
This is a global function declaration.
|
|
|
|
|
|
:param i: First param.
|
|
|
|
:param j: Second param.
|
|
|
|
|
|
:returns: A string.
|
|
|
|
.. zeek:type:: test_func_params_rec
|
|
:source-code: <...>/func-params.zeek 13 21
|
|
|
|
:Type: :zeek:type:`record`
|
|
|
|
field_func: :zeek:type:`function` (i: :zeek:type:`int`, j: :zeek:type:`int`) : :zeek:type:`string`
|
|
This is a record field function.
|
|
|
|
|
|
:param i: First param.
|
|
|
|
:param j: Second param.
|
|
|
|
|
|
:returns: A string.
|
|
|
|
|