[Bro-Dev] [JIRA] (BIT-1098) topic/jsiwek/broxygen
Jon Siwek (JIRA)
jira at bro-tracker.atlassian.net
Mon Nov 25 14:38:40 PST 2013
Jon Siwek created BIT-1098:
------------------------------
Summary: topic/jsiwek/broxygen
Key: BIT-1098
URL: https://bro-tracker.atlassian.net/browse/BIT-1098
Project: Bro Issue Tracker
Issue Type: Improvement
Components: Bro, Broccoli
Affects Versions: git/master
Reporter: Jon Siwek
Fix For: 2.3
This branch is in the bro and broccoli repos and improves the automated script-reference documentation generation process, broxygen.
This should address issues in BIT-701 and BIT-751, let me know if there's anything not covered that's still relevant.
Highlights:
- Remove {{--doc-scripts}} and {{-Z}} options to toggle documentation mode -- the parser is now always instrumented to gather documentation from comments of the form "##", "##!", or "##<".
- Raw comments are available at runtime through several BIF functions: {{get_*_comments}};
- Add {{--broxygen}} and {{-X}} options to toggle generating reST-format documentation output, driven by a config file argument.
- Add a "broxygen" Sphinx extension domain, allowing certain pieces of documentation to be generated on-the-fly via invoking a Bro process. Re-organized/cleaned up the Sphinx source tree in {{doc/}} to use this in some places.
--
This message was sent by Atlassian JIRA
(v6.2-OD-03#6206)
More information about the bro-dev
mailing list