Reformat docs in addrs.zeek to fix doc generation

This commit is contained in:
Tim Wojtulewicz 2021-09-14 19:26:28 -07:00
parent 619af69e42
commit 0dca1a70a7

View file

@ -83,9 +83,7 @@ function has_valid_octets(octets: string_vec): bool
## ##
## input: a string that may contain an IP address anywhere within it. ## input: a string that may contain an IP address anywhere within it.
## ##
## check_wrapping: if true, will only return IP addresses that are wrapped in matching ## check_wrapping: if true, will only return IP addresses that are wrapped in matching pairs of spaces, square brackets, curly braces, or parens. This can be used to avoid extracting strings that look like IPs from innocuous strings, such as SMTP headers.
## pairs of spaces, square brackets, curly braces, or parens. This can be used to avoid
## extracting strings that look like IPs from innocuous strings, such as SMTP headers.
## ##
## Returns: an array containing all valid IP address strings found in *input*. ## Returns: an array containing all valid IP address strings found in *input*.
function extract_ip_addresses(input: string, check_wrapping: bool &default=F): string_vec function extract_ip_addresses(input: string, check_wrapping: bool &default=F): string_vec