Improve config framework documentation comments

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

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.

View file

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

View file

@ -33,12 +33,12 @@ export {
## and also does not track removals. If you need this, combine the event
## 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.
##
## 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);
}