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

Fix typos in BIF documentation

Browse source 
Fixed typos in documentation of hexstr_to_bytestring.
Also added documentation that was missing for function parameters
and return values of other BIFs.
This commit is contained in:
Daniel Thayer 2013-11-22 14:49:16 -06:00
parent 7025d511e4
commit 6f06705c23
2 changed files with 15 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

20
src/bro.bif
View file

@ -973,6 +973,8 @@ function entropy_test_finish%(handle: opaque of entropy%): entropy_test_result
## ##
## prefix: A custom string prepended to the result. ## prefix: A custom string prepended to the result.
## ##
## Returns: A string identifier that is unique.
##
## .. bro:see:: unique_id_from ## .. bro:see:: unique_id_from
function unique_id%(prefix: string%) : string function unique_id%(prefix: string%) : string
%{ %{
@ -987,6 +989,8 @@ function unique_id%(prefix: string%) : string
## ##
## prefix: A custom string prepended to the result. ## prefix: A custom string prepended to the result.
## ##
## Returns: A string identifier that is unique.
##
## .. bro:see:: unique_id ## .. bro:see:: unique_id
function unique_id_from%(pool: int, prefix: string%) : string function unique_id_from%(pool: int, prefix: string%) : string
%{ %{
@ -1857,8 +1861,8 @@ function global_ids%(%): id_table
## ##
## id: The global identifier. ## id: The global identifier.
## ##
## Returns the value of *id*. If *id* does not describe a valid identifier, the ## Returns: The value of *id*. If *id* does not describe a valid identifier,
## function returns the string ``"<unknown id>"`` or ``"<no ID value>"``. ## the string ``"<unknown id>"`` or ``"<no ID value>"`` is returned.
function lookup_ID%(id: string%) : any function lookup_ID%(id: string%) : any
%{ %{
ID* i = global_scope()->Lookup(id->CheckString()); ID* i = global_scope()->Lookup(id->CheckString());
@ -2632,15 +2636,15 @@ function bytestring_to_hexstr%(bytestring: string%): string
return new StringVal(hexstr); return new StringVal(hexstr);
%} %}
## Converts a hex-string into its binary representation. ## Converts a hex-string into its binary representation.
## For example, ``"3034"`` would be converted to ``"04"``. ## For example, ``"3034"`` would be converted to ``"04"``.
## ##
## The input string is assumed to only contain 0-9 and a-f, ## The input string is assumed to contain an even number of hexadecimal digits
## otherwhise behavior is undefines. ## (0-9, a-f, or A-F), otherwise behavior is undefined.
## ##
## hexstring: The hexadecimal string representation. ## hexstr: The hexadecimal string representation.
## ##
## Returns: The binary representation of *hexstring*. ## Returns: The binary representation of *hexstr*.
## ##
## .. bro:see:: hexdump bytestring_to_hexstr ## .. bro:see:: hexdump bytestring_to_hexstr
function hexstr_to_bytestring%(hexstr: string%): string function hexstr_to_bytestring%(hexstr: string%): string
@ -4964,8 +4968,6 @@ function preserve_prefix%(a: addr, width: count%): any
## ##
## a: The subnet to preserve. ## a: The subnet to preserve.
## ##
## width: The number of bits from the top that should remain intact.
##
## .. bro:see:: preserve_prefix anonymize_addr ## .. bro:see:: preserve_prefix anonymize_addr
## ##
## .. todo:: Currently dysfunctional. ## .. todo:: Currently dysfunctional.

4
src/probabilistic/top-k.bif
View file

@ -138,6 +138,10 @@ function topk_sum%(handle: opaque of topk%): count
## Merge the second top-k data structure into the first. ## Merge the second top-k data structure into the first.
## ##
## handle1: the first TopK handle.
##
## handle2: the second TopK handle.
##
## .. note:: This does not remove any elements, the resulting data structure ## .. note:: This does not remove any elements, the resulting data structure
## can be bigger than the maximum size given on initialization. ## can be bigger than the maximum size given on initialization.
## ##