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

Fix Broxygen confusing scoped id at start of line as function parameter.

Browse source
This commit is contained in:
Jon Siwek 2011-12-07 17:08:38 -06:00
parent ab315949d6
commit 80b24513e7
3 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/scripts/example.bro
View file

@ -183,6 +183,8 @@ export {
## Summarize "an_event" here. ## Summarize "an_event" here.
## Give more details about "an_event" here. ## Give more details about "an_event" here.
## Example::an_event should not be confused as a parameter
##
## name: describe the argument here ## name: describe the argument here
global an_event: event(name: string); global an_event: event(name: string);

4
src/scan.l
View file

@ -167,7 +167,7 @@ ESCSEQ (\\([^\n]|[0-7]+|x[[:xdigit:]]+))
return TOK_POST_DOC; return TOK_POST_DOC;
} }
<DOC>##{OWS}{ID}:.* { <DOC>##{OWS}{ID}:[^:].* {
const char* id_start = skip_whitespace(yytext + 2); const char* id_start = skip_whitespace(yytext + 2);
yylval.str = copy_string(canon_doc_func_param(id_start).c_str()); yylval.str = copy_string(canon_doc_func_param(id_start).c_str());
return TOK_DOC; return TOK_DOC;
@ -181,7 +181,7 @@ ESCSEQ (\\([^\n]|[0-7]+|x[[:xdigit:]]+))
} }
} }
##{OWS}{ID}:.* { ##{OWS}{ID}:[^:].* {
if ( generate_documentation ) if ( generate_documentation )
{ {
// Comment is documenting either a function parameter or return type, // Comment is documenting either a function parameter or return type,

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

@ -217,6 +217,8 @@ Events
Summarize "an_event" here. Summarize "an_event" here.
Give more details about "an_event" here. Give more details about "an_event" here.
Example::an_event should not be confused as a parameter
:param name: describe the argument here :param name: describe the argument here