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

Improve Broxygen end-of-sentence detection.

Browse source 
This is used to display short summaries for things based on the first
sentence in the comments for it, but wouldn't work well when e.g. a
filename is used there.
This commit is contained in:
Jon Siwek 2013-10-11 13:27:04 -05:00
parent 3d010f3bb6
commit ee01a67e06
4 changed files with 40 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -20,11 +20,11 @@ Options
Types
#####
======================================= ======================================
:bro:type:`TestEnum1`: :bro:type:`enum` There's tons of ways an enum can look.
======================================= ========================================
:bro:type:`TestEnum1`: :bro:type:`enum` There's tons of ways an enum can look...
:bro:type:`TestEnum2`: :bro:type:`enum` The final comma is optional
======================================= ======================================
======================================= ========================================
Redefinitions
#############

13
testing/btest/Baseline/doc.autogen-reST-example/example.rst
View file

@ -40,13 +40,15 @@ Options
State Variables
###############
=========================================================================== =======================================
=========================================================================== ==================================================
:bro:id:`Example::a_var`: :bro:type:`bool` put some documentation for "a_var" here
:bro:id:`Example::var_with_attr`: :bro:type:`count` :bro:attr:`&persistent`
:bro:id:`Example::var_without_explicit_type`: :bro:type:`string`
=========================================================================== =======================================
:bro:id:`Example::dummy`: :bro:type:`string` The first.sentence for the summary text ends here.
=========================================================================== ==================================================
Types
#####
@ -156,6 +158,13 @@ State Variables
:Type: :bro:type:`string`
:Default: ``"this works"``
.. bro:id:: Example::dummy
:Type: :bro:type:`string`
The first.sentence for the summary text ends here. And this second
sentence doesn't show in the short description.
Types
#####
.. bro:type:: Example::SimpleEnum