base/bif/zeekygen.bif.zeek
- GLOBAL
Functions for querying script, package, or variable documentation.
- Namespace
GLOBAL
Summary
Functions
Retrieve the Zeekygen-style comments ( |
|
Retrieve the contents of a Zeek script package’s README file. |
|
Retrieve the Zeekygen-style comments ( |
|
Retrieve the Zeekygen-style summary comments ( |
Detailed Interface
Functions
- get_identifier_comments
-
Retrieve the Zeekygen-style comments (
##
) associated with an identifier (e.g. a variable or type).- Name
a script-level identifier for which to retrieve comments.
- Returns
comments associated with name. If name is not a known identifier, an empty string is returned.
- get_package_readme
-
Retrieve the contents of a Zeek script package’s README file.
- Name
the name of a Zeek script package. It must be a relative path to where it is located within a particular component of ZEEKPATH.
- Returns
contents of the package’s README file. If name is not a known package, an empty string is returned.
- get_record_field_comments
-
Retrieve the Zeekygen-style comments (
##
) associated with a record field.- Name
the name of a record type and a field within it formatted like a typical record field access: “<record_type>$<field>”.
- Returns
comments associated with the record field. If name does not point to a known record type or a known field within a record type, an empty string is returned.
- get_script_comments
-
Retrieve the Zeekygen-style summary comments (
##!
) associated with a Zeek script.- Name
the name of a Zeek script. It must be a relative path to where it is located within a particular component of ZEEKPATH and use the same file name extension/suffix as the actual file (e.g. “.zeek”).
- Returns
summary comments associated with script with name. If name is not a known script, an empty string is returned.