diff --git a/scripts/base/frameworks/broker/main.bro b/scripts/base/frameworks/broker/main.bro index 0818855d8f..835a9ed796 100644 --- a/scripts/base/frameworks/broker/main.bro +++ b/scripts/base/frameworks/broker/main.bro @@ -14,6 +14,7 @@ module Broker; export { ## A name used to identify this endpoint to peers. + ## ## .. bro:see:: Broker::connect Broker::listen const endpoint_name = "" &redef; diff --git a/scripts/base/frameworks/logging/main.bro b/scripts/base/frameworks/logging/main.bro index 3f1a0de4dc..998a0e0f6c 100644 --- a/scripts/base/frameworks/logging/main.bro +++ b/scripts/base/frameworks/logging/main.bro @@ -348,7 +348,7 @@ export { ## to handle, or one of the stream's filters has an invalid ## ``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; ## Sets the buffering status for all the writers of a given logging stream. diff --git a/scripts/base/init-bare.bro b/scripts/base/init-bare.bro index 5a5732de4a..d170d17d80 100644 --- a/scripts/base/init-bare.bro +++ b/scripts/base/init-bare.bro @@ -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. # 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_HOST = 1; ##< Host unreachable. const ICMP_UNREACH_PROTOCOL = 2; ##< Protocol unreachable. @@ -2540,7 +2540,7 @@ export { ## only comes into play as a heuristic to identify named ## pipes when the drive mapping wasn't seen by Bro. ## - ## .. bro:see::smb_pipe_connect_heuristic + ## .. bro:see:: smb_pipe_connect_heuristic const SMB::pipe_filenames: set[string] &redef; } @@ -3098,7 +3098,7 @@ type dns_edns_additional: record { ## An additional DNS TSIG record. ## -## bro:see:: dns_TSIG_addl +## .. bro:see:: dns_TSIG_addl type dns_tsig_additional: record { query: string; ##< Query. qtype: count; ##< Query type. diff --git a/scripts/policy/protocols/conn/vlan-logging.bro b/scripts/policy/protocols/conn/vlan-logging.bro index e0692c5ab5..bf5400dae7 100644 --- a/scripts/policy/protocols/conn/vlan-logging.bro +++ b/scripts/policy/protocols/conn/vlan-logging.bro @@ -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 diff --git a/src/bro.bif b/src/bro.bif index b23a673634..e086bb8ae9 100644 --- a/src/bro.bif +++ b/src/bro.bif @@ -1029,7 +1029,7 @@ function clear_table%(v: any%): any 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. ## @@ -1047,8 +1047,8 @@ function matching_subnets%(search: subnet, t: any%): subnet_vec return t->AsTableVal()->LookupSubnets(search); %} -## For a set[subnet]/table[subnet], create a new table that contains all entries that -## contain a given subnet. +## For a set[subnet]/table[subnet], create a new table that contains all entries +## that contain a given subnet. ## ## 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]. -## 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. ## ## search: the subnet to search for. @@ -1994,7 +1994,7 @@ function is_v6_addr%(a: addr%): bool ## ## 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 %{ if ( s->AsSubNet().Prefix().GetFamily() == IPv4 ) @@ -2007,7 +2007,7 @@ function is_v4_subnet%(s: subnet%): bool ## ## 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 %{ if ( s->AsSubNet().Prefix().GetFamily() == IPv6 ) @@ -2311,7 +2311,7 @@ function to_subnet%(sn: string%): subnet ## ## 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 function addr_to_subnet%(a: addr%): subnet @@ -2320,12 +2320,12 @@ function addr_to_subnet%(a: addr%): subnet 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. ## -## 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 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`. ## -## s: The subnet to convert. +## sn: The subnet. ## ## Returns: The width of the subnet. ##