mirror of
https://github.com/zeek/zeek.git
synced 2025-10-06 16:48:19 +00:00
Fix some "make doc" warnings
This commit is contained in:
parent
da6611e3c2
commit
75e69d8c09
3 changed files with 19 additions and 16 deletions
|
@ -109,21 +109,24 @@ export {
|
||||||
##
|
##
|
||||||
## r: The rule to install.
|
## r: The rule to install.
|
||||||
##
|
##
|
||||||
## Returns: If succesful, returns an ID string unique to the rule that can later
|
## Returns: If succesful, returns an ID string unique to the rule that can
|
||||||
## be used to refer to it. If unsuccessful, returns an empty string. The ID is also
|
## later be used to refer to it. If unsuccessful, returns an empty
|
||||||
## assigned to ``r$id``. Note that "successful" means "a plugin knew how to handle
|
## string. The ID is also assigned to ``r$id``. Note that
|
||||||
## the rule", it doesn't necessarily mean that it was indeed successfully put in
|
## "successful" means "a plugin knew how to handle the rule", it
|
||||||
## place, because that might happen asynchronously and thus fail only later.
|
## doesn't necessarily mean that it was indeed successfully put in
|
||||||
|
## place, because that might happen asynchronously and thus fail
|
||||||
|
## only later.
|
||||||
global add_rule: function(r: Rule) : string;
|
global add_rule: function(r: Rule) : string;
|
||||||
|
|
||||||
## Removes a rule.
|
## Removes a rule.
|
||||||
##
|
##
|
||||||
## id: The rule to remove, specified as the ID returned by :bro:id:`add_rule` .
|
## id: The rule to remove, specified as the ID returned by :bro:id:`add_rule` .
|
||||||
##
|
##
|
||||||
## Returns: True if succesful, the relevant plugin indicated that it knew how
|
## Returns: True if succesful, the relevant plugin indicated that it knew
|
||||||
## to handle the removal. Note that again "success" means the plugin accepted the
|
## how to handle the removal. Note that again "success" means the
|
||||||
## removal. They might still fail to put it into effect, as that might happen
|
## plugin accepted the removal. They might still fail to put it
|
||||||
## asynchronously and thus go wrong at that point.
|
## into effect, as that might happen asynchronously and thus go
|
||||||
|
## wrong at that point.
|
||||||
global remove_rule: function(id: string) : bool;
|
global remove_rule: function(id: string) : bool;
|
||||||
|
|
||||||
## Searches all rules affecting a certain IP address.
|
## Searches all rules affecting a certain IP address.
|
||||||
|
@ -156,7 +159,7 @@ export {
|
||||||
## r: The rule now removed.
|
## r: The rule now removed.
|
||||||
##
|
##
|
||||||
## p: The state for the plugin that had the rule in place and now
|
## p: The state for the plugin that had the rule in place and now
|
||||||
## removed it.
|
## removed it.
|
||||||
##
|
##
|
||||||
## msg: An optional informational message by the plugin.
|
## msg: An optional informational message by the plugin.
|
||||||
global rule_removed: event(r: Rule, p: PluginState, msg: string &default="");
|
global rule_removed: event(r: Rule, p: PluginState, msg: string &default="");
|
||||||
|
@ -168,7 +171,7 @@ export {
|
||||||
## i: Additional flow information, if supported by the protocol.
|
## i: Additional flow information, if supported by the protocol.
|
||||||
##
|
##
|
||||||
## p: The state for the plugin that had the rule in place and now
|
## p: The state for the plugin that had the rule in place and now
|
||||||
## removed it.
|
## removed it.
|
||||||
##
|
##
|
||||||
## msg: An optional informational message by the plugin.
|
## msg: An optional informational message by the plugin.
|
||||||
global rule_timeout: event(r: Rule, i: FlowInfo, p: PluginState);
|
global rule_timeout: event(r: Rule, i: FlowInfo, p: PluginState);
|
||||||
|
|
|
@ -11,7 +11,7 @@ export {
|
||||||
## plugin simply logs the operations it receives.
|
## plugin simply logs the operations it receives.
|
||||||
##
|
##
|
||||||
## do_something: If true, the plugin will claim it supports all operations; if
|
## do_something: If true, the plugin will claim it supports all operations; if
|
||||||
## false, it will indicate it doesn't support any.
|
## false, it will indicate it doesn't support any.
|
||||||
global create_debug: function(do_something: bool) : PluginState;
|
global create_debug: function(do_something: bool) : PluginState;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -306,10 +306,10 @@ event packet_contents%(c: connection, contents: string%);
|
||||||
## t2: The new payload.
|
## t2: The new payload.
|
||||||
##
|
##
|
||||||
## tcp_flags: A string with the TCP flags of the packet triggering the
|
## tcp_flags: A string with the TCP flags of the packet triggering the
|
||||||
## inconsistency. In the string, each character corresponds to one set flag,
|
## inconsistency. In the string, each character corresponds to one
|
||||||
## as follows: ``S`` -> SYN; ``F`` -> FIN; ``R`` -> RST; ``A`` -> ACK; ``P`` ->
|
## set flag, as follows: ``S`` -> SYN; ``F`` -> FIN; ``R`` -> RST;
|
||||||
## PUSH. This string will not always be set, only if the information is available;
|
## ``A`` -> ACK; ``P`` -> PUSH. This string will not always be set,
|
||||||
## it's "best effort".
|
## only if the information is available; it's "best effort".
|
||||||
##
|
##
|
||||||
## .. bro:see:: tcp_rexmit tcp_contents
|
## .. bro:see:: tcp_rexmit tcp_contents
|
||||||
event rexmit_inconsistency%(c: connection, t1: string, t2: string, tcp_flags: string%);
|
event rexmit_inconsistency%(c: connection, t1: string, t2: string, tcp_flags: string%);
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue