zeek/doc/scripts/example.bro

##! This is an example script that demonstrates how to document.  Comments
##! of the form ``##!`` are for the script summary.  The contents of
##! these comments are transferred directly into the auto-generated
##! `reStructuredText <http://docutils.sourceforge.net/rst.html>`_
##! (reST) document's summary section.
##!
##! .. tip:: You can embed directives and roles within ``##``-stylized comments.
##!
##! :Author: Jon Siwek <jsiwek@ncsa.illinois.edu>

# Comments that use a single pound sign (#) are not significant to
# a script's auto-generated documentation, but ones that use a
# double pound sign (##) do matter.  In some cases, like record
# field comments, it's necessary to disambiguate the field with
# which a comment associates: e.g. "##<" can be used on the same line
# as a field to signify the comment relates to it and not the
# following field.  "##<" is not meant for general use, just
# record/enum fields.
#
# Generally, the auto-doc comments (##) are associated with the
# next declaration/identifier found in the script, but the doc framework
# will track/render identifiers regardless of whether they have any
# of these special comments associated with them.
#
# The first sentence contained within the "##"-stylized comments for
# a given identifier is special in that it will be used as summary
# text in a table containing all such identifiers and short summaries.
# If there are no sentences (text terminated with '.'), then everything
# in the "##"-stylized comments up until the first empty comment
# is taken as the summary text for a given identifier.

# @load directives are self-documenting
@load notice

# "module" statements are self-documenting
module Example;

# redefinitions of "capture_filters" are self-documenting and
# go into the generated documentation's "Packet Filter" section
redef capture_filters += {
    ["ssl"] = "tcp port 443",
    ["nntps"] = "tcp port 562",
};

global example_ports = {
    443/tcp, 562/tcp,
} &redef;

# redefinitions of "dpd_config" are self-documenting and
# go into the generated doc's "Port Analysis" section
redef dpd_config += {
    [ANALYZER_SSL] = [$ports = example_ports]
};

# redefinitions of "Notice::Type" are self-documenting, but
# more information can be supplied in two different ways
redef enum Notice += {
    ## any number of this type of comment
    ## will document "Notice_One"
    Notice_One,
    Notice_Two,  ##< any number of this type of comment
                 ##< will document "Notice_Two"
    Notice_Three,
    Notice_Four,
};

# Anything declared in the export section will show up in the rendered
# documentation's "public interface" section

export {

    # these headings don't mean anything special to the
    # doc framework right now, I'm just including them
    # to make it more clear to the reader how the doc
    # framework will actually categorize a script's identifiers

    ############## types ################

    # Note that I'm just mixing the "##" and "##<"
    # types of comments in the following declarations
    # as a demonstration.  Normally, it would be good style
    # to pick one and be consistent.

    ## documentation for "SimpleEnum"
    ## goes here.
    type SimpleEnum: enum {
        ## and more specific info for "ONE"
        ## can span multiple lines
        ONE,
        TWO,  ##< or more info like this for "TWO"
              ##< can span multiple lines
        THREE,
    };

    ## document the "SimpleEnum" redef here
    redef enum SimpleEnum  += {
        FOUR, ##< and some documentation for "FOUR"
        ## also "FIVE" for good measure
        FIVE
    };

    ## general documentation for a type "SimpleRecord"
    ## goes here.
    type SimpleRecord: record {
        ## counts something
        field1: count;
        field2: bool; ##< toggles something
    };


    ## general documentation for a type "ComplexRecord" goes here
    type ComplexRecord: record {
        field1: count;               ##< counts something
        field2: bool;                ##< toggles something
        field3: SimpleRecord;
        msg: string &default="blah"; ##< attributes are self-documenting
    } &redef;

    ############## options ################
    # right now, I'm just defining an option as
    # any const with &redef (something that can
    # change at parse time, but not at run time.

    ## add documentation for "an_option" here
    const an_option: set[addr, addr, string] &redef;

    # default initialization will be self-documenting
    const option_with_init = 0.01 secs &redef;

    ############## state variables ############
    # right now, I'm defining this as any global
    # that's not a function/event.  doesn't matter
    # if &redef attribute is present

    ## put some documentation for "a_var" here
    global a_var: bool;

    # attributes are self-documenting
    global var_with_attr: count &persistent;

    # it's fine if the type is inferred, that information is self-documenting
    global var_without_explicit_type = "this works";

    ############## functions/events ############

    ## Summarize purpose of "a_function" here.
    ## Give more details about "a_function" here.
    ## Separating the documentation of the params/return values with
    ## empty comments is optional, but improves readability of script.
    ##
    ## tag: function arguments can be described
    ##      like this
    ## msg: another param
    ##
    ## Returns: describe the return type here
    global a_function: function(tag: string, msg: string): string;

    ## Summarize "an_event" here.
    ## Give more details about "an_event" here.
    ## name: describe the argument here
    global an_event: event(name: string);
}

# this function is documented in the "private interface" section
# of generated documentation and any "##"-stylized comments would also
# be rendered there
function function_without_proto(tag: string): string
    {
    return "blah";
    }

# this record type is documented in the "private interface" section
# of generated documentation and any "##"-stylized comments would also
# be rendered there
type PrivateRecord: record {
    field1: bool;
    field2: count;
};