Package: broxygen

This package is loaded during the process which automatically generates reference documentation for all Bro scripts (i.e. “Broxygen”). Its only purpose is to provide an easy way to load all known Bro scripts plus any extra scripts needed or used by the documentation process.

broxygen/__load__.bro

broxygen/example.bro

This is an example script that demonstrates Broxygen-style documentation. It generally will make most sense when viewing the script’s raw source code and comparing to the HTML-rendered version.

Comments in the from ##! are meant to summarize the script’s purpose. They are transferred directly in to the generated reStructuredText (reST) document associated with the script.

Tip

You can embed directives and roles within ##-stylized comments.

There’s also a custom role to reference any identifier node in the Bro Sphinx domain that’s good for “see alsos”, e.g.

See also: BroxygenExample::a_var, BroxygenExample::ONE, SSH::Info

And a custom directive does the equivalent references:

See also: BroxygenExample::a_var, BroxygenExample::ONE, SSH::Info