mirror of
https://github.com/zeek/zeek.git
synced 2025-10-14 04:28:20 +00:00
Teach Zeekygen to produce source-code-range information
Related to https://github.com/zeek/zeek-docs/issues/56
This commit is contained in:
parent
c95a364ff7
commit
6ac499882c
16 changed files with 147 additions and 7 deletions
|
@ -111,6 +111,7 @@ Detailed Interface
|
|||
Redefinable Options
|
||||
###################
|
||||
.. zeek:id:: ZeekygenExample::an_option
|
||||
:source-code: zeekygen/example.zeek 132 132
|
||||
|
||||
:Type: :zeek:type:`set` [:zeek:type:`addr`, :zeek:type:`addr`, :zeek:type:`string`]
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
|
@ -120,6 +121,7 @@ Redefinable Options
|
|||
The type/attribute information is all generated automatically.
|
||||
|
||||
.. zeek:id:: ZeekygenExample::option_with_init
|
||||
:source-code: zeekygen/example.zeek 135 135
|
||||
|
||||
:Type: :zeek:type:`interval`
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
|
@ -131,6 +133,7 @@ Redefinable Options
|
|||
State Variables
|
||||
###############
|
||||
.. zeek:id:: ZeekygenExample::a_var
|
||||
:source-code: zeekygen/example.zeek 140 140
|
||||
|
||||
:Type: :zeek:type:`bool`
|
||||
|
||||
|
@ -139,6 +142,7 @@ State Variables
|
|||
in the generated docs.
|
||||
|
||||
.. zeek:id:: ZeekygenExample::summary_test
|
||||
:source-code: zeekygen/example.zeek 148 148
|
||||
|
||||
:Type: :zeek:type:`string`
|
||||
|
||||
|
@ -147,6 +151,7 @@ State Variables
|
|||
by the table of all identifiers declared by this script.
|
||||
|
||||
.. zeek:id:: ZeekygenExample::var_without_explicit_type
|
||||
:source-code: zeekygen/example.zeek 143 143
|
||||
|
||||
:Type: :zeek:type:`string`
|
||||
:Default: ``"this works"``
|
||||
|
@ -156,6 +161,7 @@ State Variables
|
|||
Types
|
||||
#####
|
||||
.. zeek:type:: ZeekygenExample::ComplexRecord
|
||||
:source-code: zeekygen/example.zeek 110 117
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
@ -177,6 +183,7 @@ Types
|
|||
General documentation for a type "ComplexRecord" goes here.
|
||||
|
||||
.. zeek:type:: ZeekygenExample::Info
|
||||
:source-code: zeekygen/example.zeek 124 128
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
@ -193,6 +200,7 @@ Types
|
|||
(provided they are also @load'ed).
|
||||
|
||||
.. zeek:type:: ZeekygenExample::SimpleEnum
|
||||
:source-code: zeekygen/example.zeek 78 85
|
||||
|
||||
:Type: :zeek:type:`enum`
|
||||
|
||||
|
@ -219,6 +227,7 @@ Types
|
|||
It can span multiple lines.
|
||||
|
||||
.. zeek:type:: ZeekygenExample::SimpleRecord
|
||||
:source-code: zeekygen/example.zeek 97 101
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
@ -239,6 +248,7 @@ Types
|
|||
Events
|
||||
######
|
||||
.. zeek:id:: ZeekygenExample::an_event
|
||||
:source-code: zeekygen/example.zeek 171 171
|
||||
|
||||
:Type: :zeek:type:`event` (name: :zeek:type:`string`)
|
||||
|
||||
|
@ -255,6 +265,7 @@ Events
|
|||
Functions
|
||||
#########
|
||||
.. zeek:id:: ZeekygenExample::a_function
|
||||
:source-code: zeekygen/example.zeek 161 161
|
||||
|
||||
:Type: :zeek:type:`function` (tag: :zeek:type:`string`, msg: :zeek:type:`string`) : :zeek:type:`string`
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue