Source code for zlogging.enum.ZeekygenExample

# -*- coding: utf-8 -*-
"""Namespace: ``ZeekygenExample``."""

from zlogging._compat import enum



[docs]@enum.unique
class SimpleEnum(enum.IntFlag):
    """Documentation for the “SimpleEnum” type goes here.
    It can span multiple lines.

    c.f. `zeekygen/example.zeek <https://docs.zeek.org/en/stable/scripts/zeekygen/example.zeek.html#type-ZeekygenExample::SimpleEnum>`__

    """

    _ignore_ = 'SimpleEnum _'
    SimpleEnum = vars()

    #: Documentation for particular enum values is added like this.
    #: And can also span multiple lines.
    SimpleEnum['ONE'] = enum.auto()

    #: Or this style is valid to document the preceding enum value.
    SimpleEnum['TWO'] = enum.auto()

    SimpleEnum['THREE'] = enum.auto()

    #: And some documentation for “FOUR”.
    SimpleEnum['FOUR'] = enum.auto()

    #: Also “FIVE”.
    SimpleEnum['FIVE'] = enum.auto()