Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-06 00:28:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Improve config framework documentation comments

Browse source 
Fixed typos and formatting.
This commit is contained in:
Daniel Thayer 2018-03-15 14:16:00 -05:00
parent c759583d11
commit f3e42874b8
4 changed files with 28 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

2
scripts/base/frameworks/config/README
View file

@ -1,2 +1,2 @@
The configuration famework provides a way to change the Bro configuration The configuration framework provides a way to change the Bro configuration
in "option" values at run-time. in "option" values at run-time.

4
scripts/base/frameworks/config/main.bro
View file

@ -1,6 +1,6 @@
##! The configuration framework provides a way to change Bro options ##! The configuration framework provides a way to change Bro options
##! (as specified by the option keyword) at runtime. It also logs runtime changes ##! (as specified by the "option" keyword) at runtime. It also logs runtime
##! to options to config.log. ##! changes to options to config.log.
module Config; module Config;

6
scripts/base/frameworks/input/readers/config.bro
View file

@ -33,12 +33,12 @@ export {
## and also does not track removals. If you need this, combine the event ## and also does not track removals. If you need this, combine the event
## with a table reader. ## with a table reader.
## ##
## name: name of the input stream. ## name: Name of the input stream.
## ##
## source: source of the input stream. ## source: Source of the input stream.
## ##
## id: ID of the configuration option being set. ## id: ID of the configuration option being set.
## ##
## value: new value of the configuration option being set. ## value: New value of the configuration option being set.
global new_value: event(name: string, source: string, id: string, value: any); global new_value: event(name: string, source: string, id: string, value: any);
} }

43
src/option.bif
View file

@ -1,6 +1,5 @@
##! The option built-in functions allow the scripting layer to ##! Definitions of built-in functions that allow the scripting layer to
##! change the value of option-values and to be notified when ##! change the value of options and to be notified when option values change.
##! option values change.
module Option; module Option;
@ -8,16 +7,16 @@ module Option;
#include "NetVar.h" #include "NetVar.h"
%%} %%}
## Sets an option to a new value. This change will also cause the option change handlers ## Set an option to a new value. This change will also cause the option change
## to be called. ## handlers to be called.
## ##
## ID: The ID of the option to update. ## ID: The ID of the option to update.
## ##
## val: The new value of the option. ## val: The new value of the option.
## ##
## location: optional parameter detailing where this change originated from. ## location: Optional parameter detailing where this change originated from.
## ##
## Returns: true on success, false when an error occured. ## Returns: true on success, false when an error occurred.
## ##
## .. bro:see:: Option::set_change_handler ## .. bro:see:: Option::set_change_handler
function Option::set%(ID: string, val: any, location: string &default=""%): bool function Option::set%(ID: string, val: any, location: string &default=""%): bool
@ -74,24 +73,26 @@ function Option::set%(ID: string, val: any, location: string &default=""%): bool
return new Val(1, TYPE_BOOL); return new Val(1, TYPE_BOOL);
%} %}
## Set the change handler for the option *ID*. The change handler will be called anytime ## Set a change handler for an option. The change handler will be
## :bro:id:`Option::set` is called fot *ID*. ## called anytime :bro:id:`Option::set` is called for the option.
## ##
## ID: The ID of the option for which change notifications are desired. ## ID: The ID of the option for which change notifications are desired.
## ##
## on_change: The function that will be called when a change occurs. The function can choose to ## on_change: The function that will be called when a change occurs. The
## receive two or three parameters: the first parameter is a string containing *ID*, ## function can choose to receive two or three parameters: the first
## the second parameter is the new option value. The third, optional, parameter is the ## parameter is a string containing *ID*, the second parameter is
## location string as passed to Option::set. Note that the global value is not yet changed ## the new option value. The third, optional, parameter is the
## when the function is called. The passed function has to return the new value that ## location string as passed to Option::set. Note that the global
## it wants the option to be set to. This enables it to reject changes, or change values ## value is not yet changed when the function is called. The passed
## that are being set. When several change handlers are set for an option they are chained; ## function has to return the new value that it wants the option to
## the second change handler will see the return value of the first change handler as the ## be set to. This enables it to reject changes, or change values
## "new value". ## that are being set. When several change handlers are set for an
## option they are chained; the second change handler will see the
## return value of the first change handler as the "new value".
## ##
## priority: The priority of the function that was added; functions with higher priority are ## priority: The priority of the function that was added; functions with higher
## called first, functions with the same priority are called in the order in which ## priority are called first, functions with the same priority are
## they were added. ## called in the order in which they were added.
## ##
## Returns: true when the change handler was set, false when an error occurred. ## Returns: true when the change handler was set, false when an error occurred.
## ##