Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-02 14:48:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Teach Broxygen the .. bro:see:: directive

Browse source
This commit is contained in:
Jon Siwek 2011-11-19 07:19:57 -06:00
parent d3d09b798a
commit 305621672f
3 changed files with 63 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/scripts/example.bro
View file

@ -8,8 +8,13 @@
##!
##! 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`"
##!
##! See also: :bro:see:`Example::a_var`, :bro:see:`Example::ONE`,
##! :bro:see:`SSH::Info`
##!
##! And a custom directive does the equivalent references:
##!
##! .. bro:see:: Example::a_var Example::ONE SSH::Info
# Comments that use a single pound sign (#) are not significant to
# a script's auto-generated documentation, but ones that use a