Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-04 23:58:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Teach Broxygen :bro:see: role for referencing any identifier in Bro domain.

Browse source
This commit is contained in:
Jon Siwek 2011-11-17 16:55:51 -06:00
parent ec33453d2d
commit 5227eb73c8
3 changed files with 40 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/scripts/example.bro
View file

@ -5,6 +5,11 @@
##! (reST) document's summary section.
##!
##! .. 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 :bro:see:`Example::a_var`, :bro:see:`Example::ONE`, and
##! :bro:see:`SSH::Info`"
# Comments that use a single pound sign (#) are not significant to
# a script's auto-generated documentation, but ones that use a