mirror of
https://github.com/zeek/zeek.git
synced 2025-10-04 15:48:19 +00:00
Various changes to documentation framework.
- 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.
This commit is contained in:
parent
eda2245e9e
commit
80e154ba3c
13 changed files with 137 additions and 43 deletions
|
@ -52,7 +52,7 @@ export {
|
|||
## If not given, all entries are recorded.
|
||||
##
|
||||
## rec: An instance of the streams's ``columns`` type with its
|
||||
## fields set to the values to logged.
|
||||
## fields set to the values to logged.
|
||||
##
|
||||
## Returns: True if the entry is to be recorded.
|
||||
pred: function(rec: any): bool &optional;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue