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

Merge remote-tracking branch 'origin/topic/jsiwek/improve-enum-doc'

Browse source 
* origin/topic/jsiwek/improve-enum-doc:
  Improve auto-generated enum documentation.

Closes #919.
This commit is contained in:
Robin Sommer 2012-11-23 18:26:06 -08:00
commit 96ce99590d
6 changed files with 54 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
testing/btest/Baseline/doc.autogen-reST-enums/autogen-reST-enums.rst
View file

@ -12,6 +12,12 @@ autogen-reST-enums.bro
Summary
~~~~~~~
Options
#######
==================================================================== ======================================================================
:bro:id:`test_enum_option`: :bro:type:`TestEnum1` :bro:attr:`&redef` this should reference the TestEnum1 type and not a generic "enum" type
==================================================================== ======================================================================
Types
#####
======================================= ======================================
@ -30,6 +36,16 @@ Redefinitions
Detailed Interface
~~~~~~~~~~~~~~~~~~
Options
#######
.. bro:id:: test_enum_option
:Type: :bro:type:`TestEnum1`
:Attributes: :bro:attr:`&redef`
:Default: ``ONE``
this should reference the TestEnum1 type and not a generic "enum" type
Types
#####
.. bro:type:: TestEnum1

3
testing/btest/doc/autogen-reST-enums.bro
View file

@ -34,3 +34,6 @@ redef enum TestEnum1 += {
## adding another
FIVE, ##< value
};
## this should reference the TestEnum1 type and not a generic "enum" type
const test_enum_option = ONE &redef;