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

Fix minor typos in documentation

Browse source 
Some of these fixes are for broken links in the auto-generated docs.
This commit is contained in:
Daniel Thayer 2016-11-14 09:48:33 -06:00
parent 67160338ba
commit 475682ba7f
5 changed files with 17 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

1
scripts/base/frameworks/broker/main.bro
View file

@ -14,6 +14,7 @@ module Broker;
export { export {
## A name used to identify this endpoint to peers. ## A name used to identify this endpoint to peers.
##
## .. bro:see:: Broker::connect Broker::listen ## .. bro:see:: Broker::connect Broker::listen
const endpoint_name = "" &redef; const endpoint_name = "" &redef;

2
scripts/base/frameworks/logging/main.bro
View file

@ -348,7 +348,7 @@ export {
## to handle, or one of the stream's filters has an invalid ## to handle, or one of the stream's filters has an invalid
## ``path_func``. ## ``path_func``.
## ##
## .. bro:see: Log::enable_stream Log::disable_stream ## .. bro:see:: Log::enable_stream Log::disable_stream
global write: function(id: ID, columns: any) : bool; global write: function(id: ID, columns: any) : bool;
## Sets the buffering status for all the writers of a given logging stream. ## Sets the buffering status for all the writers of a given logging stream.

4
scripts/base/init-bare.bro
View file

@ -1129,7 +1129,7 @@ const CONTENTS_BOTH = 3; ##< Record both originator and responder contents.
# Values for code of ICMP *unreachable* messages. The list is not exhaustive. # Values for code of ICMP *unreachable* messages. The list is not exhaustive.
# todo:: these should go into an enum to make them autodoc'able # todo:: these should go into an enum to make them autodoc'able
# #
# .. bro:see:: :bro:see:`icmp_unreachable ` # .. bro:see:: icmp_unreachable
const ICMP_UNREACH_NET = 0; ##< Network unreachable. const ICMP_UNREACH_NET = 0; ##< Network unreachable.
const ICMP_UNREACH_HOST = 1; ##< Host unreachable. const ICMP_UNREACH_HOST = 1; ##< Host unreachable.
const ICMP_UNREACH_PROTOCOL = 2; ##< Protocol unreachable. const ICMP_UNREACH_PROTOCOL = 2; ##< Protocol unreachable.
@ -3098,7 +3098,7 @@ type dns_edns_additional: record {
## An additional DNS TSIG record. ## An additional DNS TSIG record.
## ##
## bro:see:: dns_TSIG_addl ## .. bro:see:: dns_TSIG_addl
type dns_tsig_additional: record { type dns_tsig_additional: record {
query: string; ##< Query. query: string; ##< Query.
qtype: count; ##< Query type. qtype: count; ##< Query type.

2
scripts/policy/protocols/conn/vlan-logging.bro
View file

@ -1,4 +1,4 @@
##! This script add VLAN information to the connection logs ##! This script adds VLAN information to the connection log.
@load base/protocols/conn @load base/protocols/conn

22
src/bro.bif
View file

@ -1029,7 +1029,7 @@ function clear_table%(v: any%): any
return 0; return 0;
%} %}
## Gets all subnets that contain a given subnet from a set/table[subnet] ## Gets all subnets that contain a given subnet from a set/table[subnet].
## ##
## search: the subnet to search for. ## search: the subnet to search for.
## ##
@ -1047,8 +1047,8 @@ function matching_subnets%(search: subnet, t: any%): subnet_vec
return t->AsTableVal()->LookupSubnets(search); return t->AsTableVal()->LookupSubnets(search);
%} %}
## For a set[subnet]/table[subnet], create a new table that contains all entries that ## For a set[subnet]/table[subnet], create a new table that contains all entries
## contain a given subnet. ## that contain a given subnet.
## ##
## search: the subnet to search for. ## search: the subnet to search for.
## ##
@ -1067,7 +1067,7 @@ function filter_subnet_table%(search: subnet, t: any%): any
%} %}
## Checks if a specific subnet is a member of a set/table[subnet]. ## Checks if a specific subnet is a member of a set/table[subnet].
## In difference to the ``in`` operator, this performs an exact match, not ## In contrast to the ``in`` operator, this performs an exact match, not
## a longest prefix match. ## a longest prefix match.
## ##
## search: the subnet to search for. ## search: the subnet to search for.
@ -1994,7 +1994,7 @@ function is_v6_addr%(a: addr%): bool
## ##
## s: the subnet to check. ## s: the subnet to check.
## ##
## Returns: true if *a* is an IPv4 subnet, else false. ## Returns: true if *s* is an IPv4 subnet, else false.
function is_v4_subnet%(s: subnet%): bool function is_v4_subnet%(s: subnet%): bool
%{ %{
if ( s->AsSubNet().Prefix().GetFamily() == IPv4 ) if ( s->AsSubNet().Prefix().GetFamily() == IPv4 )
@ -2007,7 +2007,7 @@ function is_v4_subnet%(s: subnet%): bool
## ##
## s: the subnet to check. ## s: the subnet to check.
## ##
## Returns: true if *a* is an IPv6 subnet, else false. ## Returns: true if *s* is an IPv6 subnet, else false.
function is_v6_subnet%(s: subnet%): bool function is_v6_subnet%(s: subnet%): bool
%{ %{
if ( s->AsSubNet().Prefix().GetFamily() == IPv6 ) if ( s->AsSubNet().Prefix().GetFamily() == IPv6 )
@ -2311,7 +2311,7 @@ function to_subnet%(sn: string%): subnet
## ##
## a: The address to convert. ## a: The address to convert.
## ##
## Returns: The *a* address as a :bro:type:`subnet`. ## Returns: The address as a :bro:type:`subnet`.
## ##
## .. bro:see:: to_subnet ## .. bro:see:: to_subnet
function addr_to_subnet%(a: addr%): subnet function addr_to_subnet%(a: addr%): subnet
@ -2320,12 +2320,12 @@ function addr_to_subnet%(a: addr%): subnet
return new SubNetVal(a->AsAddr(), width); return new SubNetVal(a->AsAddr(), width);
%} %}
## Converts a :bro:type:`subnet` to a :bro:type:`addr` by ## Converts a :bro:type:`subnet` to an :bro:type:`addr` by
## extracting the prefix. ## extracting the prefix.
## ##
## s: The subnet to convert. ## sn: The subnet to convert.
## ##
## Returns: The *s* subnet as a :bro:type:`addr`. ## Returns: The subnet as an :bro:type:`addr`.
## ##
## .. bro:see:: to_subnet ## .. bro:see:: to_subnet
function subnet_to_addr%(sn: subnet%): addr function subnet_to_addr%(sn: subnet%): addr
@ -2335,7 +2335,7 @@ function subnet_to_addr%(sn: subnet%): addr
## Returns the width of a :bro:type:`subnet`. ## Returns the width of a :bro:type:`subnet`.
## ##
## s: The subnet to convert. ## sn: The subnet.
## ##
## Returns: The width of the subnet. ## Returns: The width of the subnet.
## ##