mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 14:48:21 +00:00
Add summary documentation to bif files.
This commit is contained in:
parent
aa69fd53fb
commit
b8778026a6
5 changed files with 18 additions and 5 deletions
|
@ -1,4 +1,8 @@
|
||||||
# Definitions of Bro built-in functions.
|
##! A collection of built-in functions that implement a variety of things
|
||||||
|
##! such as general programming algorithms, string processing, math functions,
|
||||||
|
##! introspection, type conversion, file/directory manipulation, packet
|
||||||
|
##! filtering, inter-process communication and controlling protocol analyzer
|
||||||
|
##! behavior.
|
||||||
|
|
||||||
%%{ // C segment
|
%%{ // C segment
|
||||||
#include <math.h>
|
#include <math.h>
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
# Documentation and default values for these are located in policy/bro.init.
|
##! Declaration of various scripting-layer constants that the Bro core uses
|
||||||
|
##! internally. Documentation and default values for the scripting-layer
|
||||||
|
##! variables themselves are found in :doc:`/scripts/base/init-bare`.
|
||||||
|
|
||||||
const ignore_keep_alive_rexmit: bool;
|
const ignore_keep_alive_rexmit: bool;
|
||||||
const skip_http_data: bool;
|
const skip_http_data: bool;
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
##! The events that the C/C++ core of Bro can generate. This is mostly
|
||||||
|
##! consisting the high-level network events that protocol analyzers detect,
|
||||||
|
##! but there are also several general-utilit yevents generated by internal
|
||||||
|
##! Bro frameworks.
|
||||||
|
|
||||||
#
|
#
|
||||||
# Documentation conventions:
|
# Documentation conventions:
|
||||||
#
|
#
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
# Definitions of Bro built-in functions related to strings.
|
##! Definitions of built-in functions related to string processing and
|
||||||
|
##! manipulation.
|
||||||
|
|
||||||
|
|
||||||
%%{ // C segment
|
%%{ // C segment
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
##! Declaration of various types that the Bro core uses internally.
|
||||||
|
|
||||||
enum dce_rpc_ptype %{
|
enum dce_rpc_ptype %{
|
||||||
DCE_RPC_REQUEST,
|
DCE_RPC_REQUEST,
|
||||||
|
@ -134,8 +135,8 @@ enum createmode_t %{
|
||||||
EXCLUSIVE = 2,
|
EXCLUSIVE = 2,
|
||||||
%}
|
%}
|
||||||
|
|
||||||
# Decleare record types that we want to access from the even engine. These are
|
# Decleare record types that we want to access from the event engine. These are
|
||||||
# defined in bro.init.
|
# defined in init-bare.bro.
|
||||||
type info_t: record;
|
type info_t: record;
|
||||||
type fattr_t: record;
|
type fattr_t: record;
|
||||||
type diropargs_t: record;
|
type diropargs_t: record;
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue