mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 06:38:20 +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.
20 lines
439 B
Text
20 lines
439 B
Text
# @TEST-EXEC: bro --doc-scripts %INPUT
|
|
# @TEST-EXEC: btest-diff autogen-reST-func-params.rst
|
|
|
|
## This is a global function declaration.
|
|
##
|
|
## i: First param.
|
|
## j: Second param.
|
|
##
|
|
## Returns: A string.
|
|
global test_func: function(i: int, j: int): string;
|
|
|
|
type test_rec: record {
|
|
## This is a record field function.
|
|
##
|
|
## i: First param.
|
|
## j: Second param.
|
|
##
|
|
## Returns: A string.
|
|
field_func: function(i: int, j: int): string;
|
|
};
|