mirror of
https://github.com/zeek/zeek.git
synced 2025-10-17 14:08:20 +00:00
Correct various errors in the BIF documentation
This commit is contained in:
Daniel Thayer
parent
5f3575425d
commit
be65ddca37
2 changed files with 131 additions and 129 deletions
|
|
@ -11,8 +11,8 @@ using namespace std;
|
|||
%%}
|
||||
|
||||
|
||||
## Concates all arguments into a single string. The function takes a variable
|
||||
## number of arguments of type string and stiches them together.
|
||||
## Concatenates all arguments into a single string. The function takes a
|
||||
## variable number of arguments of type string and stitches them together.
|
||||
##
|
||||
## Returns: The concatenation of all (string) arguments.
|
||||
##
|
||||
|
|
@ -157,9 +157,9 @@ function join_string_array%(sep: string, a: string_array%): string
|
|||
##
|
||||
## sep: The separator to place between each element.
|
||||
##
|
||||
## a: The :bro:type:`string_vec` (``vector of string``).
|
||||
## vec: The :bro:type:`string_vec` (``vector of string``).
|
||||
##
|
||||
## Returns: The concatenation of all elements in *a*, with *sep* placed
|
||||
## Returns: The concatenation of all elements in *vec*, with *sep* placed
|
||||
## between each element.
|
||||
##
|
||||
## .. bro:see:: cat cat_sep string_cat cat_string_array cat_string_array_n
|
||||
|
|
@ -219,7 +219,7 @@ function sort_string_array%(a: string_array%): string_array
|
|||
|
||||
## Returns an edited version of a string that applies a special
|
||||
## "backspace character" (usually ``\x08`` for backspace or ``\x7f`` for DEL).
|
||||
## For ## example, ``edit("hello there", "e")`` returns ``"llo t"``.
|
||||
## For example, ``edit("hello there", "e")`` returns ``"llo t"``.
|
||||
##
|
||||
## arg_s: The string to edit.
|
||||
##
|
||||
|
|
@ -229,7 +229,7 @@ function sort_string_array%(a: string_array%): string_array
|
|||
## the string.
|
||||
##
|
||||
## Returns: An edited version of *arg_s* where *arg_edit_char* triggers the
|
||||
## deletetion of the last character.
|
||||
## deletion of the last character.
|
||||
##
|
||||
## .. bro:see:: clean
|
||||
## to_string_literal
|
||||
|
|
@ -278,7 +278,7 @@ function byte_len%(s: string%): count
|
|||
return new Val(s->Len(), TYPE_COUNT);
|
||||
%}
|
||||
|
||||
## Get a substring of from a string, given a starting position length.
|
||||
## Get a substring from a string, given a starting position and length.
|
||||
##
|
||||
## s: The string to obtain a substring from.
|
||||
##
|
||||
|
|
@ -486,10 +486,10 @@ function split%(str: string, re: pattern%): string_array
|
|||
return do_split(str, re, 0, 0, 0);
|
||||
%}
|
||||
|
||||
## Splits a string *once* into a a two-element array of strings according to a
|
||||
## pattern. This function is the same as :bro:id:`split`, but * is only split
|
||||
## once (if possible) at the earliest position and an array of two strings is
|
||||
## returned.
|
||||
## Splits a string *once* into a two-element array of strings according to a
|
||||
## pattern. This function is the same as :bro:id:`split`, but *str* is only
|
||||
## split once (if possible) at the earliest position and an array of two strings
|
||||
## is returned.
|
||||
##
|
||||
## str: The string to split.
|
||||
##
|
||||
|
|
@ -518,7 +518,7 @@ function split1%(str: string, re: pattern%): string_array
|
|||
##
|
||||
## Returns: An array of strings where each two successive elements correspond
|
||||
## to a substring in *str* of the part not matching *re* (odd-indexed)
|
||||
## and thei part that matches *re* (even-indexed).
|
||||
## and the part that matches *re* (even-indexed).
|
||||
##
|
||||
## .. bro:see:: split split1 split_n str_split
|
||||
function split_all%(str: string, re: pattern%): string_array
|
||||
|
|
@ -568,7 +568,7 @@ function split_complete%(str: string,
|
|||
##
|
||||
## re: The pattern being replaced with *repl*.
|
||||
##
|
||||
## repl: The string that replacs *re*.
|
||||
## repl: The string that replaces *re*.
|
||||
##
|
||||
## Returns: A copy of *str* with the first occurence of *re* replaced with
|
||||
## *repl*.
|
||||
|
|
@ -579,16 +579,16 @@ function sub%(str: string, re: pattern, repl: string%): string
|
|||
return do_sub(str, re, repl, 0);
|
||||
%}
|
||||
|
||||
## Substitutes a given replacement string for the all occurrences of a pattern
|
||||
## Substitutes a given replacement string for all occurrences of a pattern
|
||||
## in a given string.
|
||||
##
|
||||
## str: The string to perform the substitution in.
|
||||
##
|
||||
## re: The pattern being replaced with *repl*.
|
||||
##
|
||||
## repl: The string that replacs *re*.
|
||||
## repl: The string that replaces *re*.
|
||||
##
|
||||
## Returns: A copy of *str* with all occurences of *re* replaced with *repl*.
|
||||
## Returns: A copy of *str* with all occurrences of *re* replaced with *repl*.
|
||||
##
|
||||
## .. bro:see:: sub subst_string
|
||||
function gsub%(str: string, re: pattern, repl: string%): string
|
||||
|
|
@ -597,7 +597,7 @@ function gsub%(str: string, re: pattern, repl: string%): string
|
|||
%}
|
||||
|
||||
|
||||
## Lexicographically compares two string.
|
||||
## Lexicographically compares two strings.
|
||||
##
|
||||
## s1: The first string.
|
||||
##
|
||||
|
|
@ -616,7 +616,7 @@ function strcmp%(s1: string, s2: string%): int
|
|||
##
|
||||
## little: The (smaller) string to find inside *big*.
|
||||
##
|
||||
## Returns: The location of *little* in *big* or 0 if *little* is not found in
|
||||
## Returns: The location of *little* in *big*, or 0 if *little* is not found in
|
||||
## *big*.
|
||||
##
|
||||
## .. bro:see:: find_all find_last
|
||||
|
|
@ -685,7 +685,7 @@ function subst_string%(s: string, from: string, to: string%): string
|
|||
## str: The string to convert to lowercase letters.
|
||||
##
|
||||
## Returns: A copy of the given string with the uppercase letters (as indicated
|
||||
## by ``isascii`` and \verb|isupper|``) folded to lowercase
|
||||
## by ``isascii`` and ``isupper``) folded to lowercase
|
||||
## (via ``tolower``).
|
||||
##
|
||||
## .. bro:see:: to_upper is_ascii
|
||||
|
|
@ -714,7 +714,7 @@ function to_lower%(str: string%): string
|
|||
## str: The string to convert to uppercase letters.
|
||||
##
|
||||
## Returns: A copy of the given string with the lowercase letters (as indicated
|
||||
## by ``isascii`` and \verb|islower|``) folded to uppercase
|
||||
## by ``isascii`` and ``islower``) folded to uppercase
|
||||
## (via ``toupper``).
|
||||
##
|
||||
## .. bro:see:: to_lower is_ascii
|
||||
|
|
@ -744,7 +744,7 @@ function to_upper%(str: string%): string
|
|||
## - ``NUL`` to ``\0``
|
||||
## - ``DEL`` to ``^?``
|
||||
## - values <= 26 to ``^[A-Z]``
|
||||
## - values not in *[32, 126]** to ``%XX``
|
||||
## - values not in *[32, 126]* to ``%XX``
|
||||
##
|
||||
## If the string does not yet have a trailing NUL, one is added.
|
||||
##
|
||||
|
|
@ -765,7 +765,7 @@ function clean%(str: string%): string
|
|||
## - ``NUL`` to ``\0``
|
||||
## - ``DEL`` to ``^?``
|
||||
## - values <= 26 to ``^[A-Z]``
|
||||
## - values not in *[32, 126]** to ``%XX``
|
||||
## - values not in *[32, 126]* to ``%XX``
|
||||
##
|
||||
## str: The string to escape.
|
||||
##
|
||||
|
|
@ -831,14 +831,16 @@ function string_to_ascii_hex%(s: string%): string
|
|||
return new StringVal(new BroString(1, (u_char*) x, s->Len() * 2));
|
||||
%}
|
||||
|
||||
## Uses the Smith Waterman algorithm to find similar/overlapping substrings.
|
||||
## Uses the Smith-Waterman algorithm to find similar/overlapping substrings.
|
||||
## See `Wikipedia <http://en.wikipedia.org/wiki/Smith%E2%80%93Waterman_algorithm>`_.
|
||||
##
|
||||
## s1: The first string.
|
||||
##
|
||||
## s2: The second string.
|
||||
##
|
||||
## Returns: The result of the Smit Waterman algorithm calculation.
|
||||
## params: Parameters for the Smith-Waterman algorithm.
|
||||
##
|
||||
## Returns: The result of the Smith-Waterman algorithm calculation.
|
||||
function str_smith_waterman%(s1: string, s2: string, params: sw_params%) : sw_substring_vec
|
||||
%{
|
||||
SWParams sw_params(params->AsRecordVal()->Lookup(0)->AsCount(),
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue