mirror of
https://github.com/zeek/zeek.git
synced 2025-10-10 02:28:21 +00:00
80e154ba3c
- Reorganize top-level 'doc' Makefile target so submodules can easily add their own doc-generating routines to it. e.g. the Bro project makes a placeholder 'doc' target, then adds 'restdoc', 'sphinxdoc'; later Broccoli can add it's own target as a dependency for generating API docs. - Fixed generated docs for BIFs not being organized under a base/ subdirectory like the original source files. - Fixed documentation style for function parameters not applying to functions declared as record fields. - Misc. script documentation tweaks to address warnings given by Sphinx.
57 lines
1.2 KiB
ReStructuredText
57 lines
1.2 KiB
ReStructuredText
.. Automatically generated. Do not edit.
|
|
|
|
autogen-reST-func-params.bro
|
|
============================
|
|
|
|
:download:`Original Source File <autogen-reST-func-params.bro>`
|
|
|
|
Overview
|
|
--------
|
|
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Types
|
|
#####
|
|
======================================== =
|
|
:bro:type:`test_rec`: :bro:type:`record`
|
|
======================================== =
|
|
|
|
Functions
|
|
#########
|
|
===================================== ======================================
|
|
:bro:id:`test_func`: :bro:type:`func` This is a global function declaration.
|
|
===================================== ======================================
|
|
|
|
Public 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.
|
|
|