mirror of
https://github.com/zeek/zeek.git
synced 2025-10-05 08:08:19 +00:00
Fixing doc tests in the btest suite.
- reduce number of docs generated by `make doc`; will add as they're reviewed - Conforming to new Notice::Type enum for notices
This commit is contained in:
parent
7399b79dd2
commit
68784634ff
4 changed files with 8 additions and 23 deletions
|
@ -129,24 +129,8 @@ endmacro(REST_TARGET)
|
||||||
# Schedule Bro scripts for which to generate documentation.
|
# Schedule Bro scripts for which to generate documentation.
|
||||||
# Note: the script may be located in a subdirectory off of one of the main
|
# Note: the script may be located in a subdirectory off of one of the main
|
||||||
# directories in BROPATH. In that case, just list the script as 'foo/bar.bro'
|
# directories in BROPATH. In that case, just list the script as 'foo/bar.bro'
|
||||||
rest_target(${POLICY_SRC_DIR} alarm.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} arp.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} conn.bro user)
|
rest_target(${POLICY_SRC_DIR} conn.bro user)
|
||||||
rest_target(${POLICY_SRC_DIR} dhcp.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} dns.bro user)
|
rest_target(${POLICY_SRC_DIR} dns.bro user)
|
||||||
rest_target(${POLICY_SRC_DIR} ftp.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} http.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} http-reply.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} http-request.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} irc.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} smtp.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} ssl.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} ssl-ciphers.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} ssl-errors.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} synflood.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} tcp.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} udp.bro user)
|
|
||||||
rest_target(${POLICY_SRC_DIR} weird.bro user)
|
|
||||||
rest_target(${CMAKE_CURRENT_SOURCE_DIR} example.bro internal)
|
rest_target(${CMAKE_CURRENT_SOURCE_DIR} example.bro internal)
|
||||||
|
|
||||||
# Finding out what scripts bro will generate documentation for by default
|
# Finding out what scripts bro will generate documentation for by default
|
||||||
|
|
|
@ -66,7 +66,7 @@ redef dpd_config += {
|
||||||
|
|
||||||
# redefinitions of "Notice::Type" are self-documenting, but
|
# redefinitions of "Notice::Type" are self-documenting, but
|
||||||
# more information can be supplied in two different ways
|
# more information can be supplied in two different ways
|
||||||
redef enum Notice += {
|
redef enum Notice::Type += {
|
||||||
## any number of this type of comment
|
## any number of this type of comment
|
||||||
## will document "Notice_One"
|
## will document "Notice_One"
|
||||||
Notice_One,
|
Notice_One,
|
||||||
|
|
|
@ -1059,7 +1059,8 @@ decl:
|
||||||
BroDocObj* o = new BroDocObj(fake_id, reST_doc_comments, true);
|
BroDocObj* o = new BroDocObj(fake_id, reST_doc_comments, true);
|
||||||
o->SetRole(true);
|
o->SetRole(true);
|
||||||
|
|
||||||
if ( streq(fake_id->Name(), "Notice" ) )
|
if ( extract_module_name(fake_id->Name()) == "Notice" &&
|
||||||
|
extract_var_name(fake_id->Name()) == "Type" )
|
||||||
current_reST_doc->AddNotice(o);
|
current_reST_doc->AddNotice(o);
|
||||||
else
|
else
|
||||||
current_reST_doc->AddRedef(o);
|
current_reST_doc->AddRedef(o);
|
||||||
|
|
|
@ -98,23 +98,23 @@ Namespaces
|
||||||
|
|
||||||
Notices
|
Notices
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
:bro:type:`Notice`
|
:bro:type:`Notice::Type`
|
||||||
|
|
||||||
:Type: :bro:type:`enum`
|
:Type: :bro:type:`enum`
|
||||||
|
|
||||||
.. bro:enum:: Example::Notice_One Notice
|
.. bro:enum:: Example::Notice_One Notice::Type
|
||||||
|
|
||||||
any number of this type of comment
|
any number of this type of comment
|
||||||
will document "Notice_One"
|
will document "Notice_One"
|
||||||
|
|
||||||
.. bro:enum:: Example::Notice_Two Notice
|
.. bro:enum:: Example::Notice_Two Notice::Type
|
||||||
|
|
||||||
any number of this type of comment
|
any number of this type of comment
|
||||||
will document "Notice_Two"
|
will document "Notice_Two"
|
||||||
|
|
||||||
.. bro:enum:: Example::Notice_Three Notice
|
.. bro:enum:: Example::Notice_Three Notice::Type
|
||||||
|
|
||||||
.. bro:enum:: Example::Notice_Four Notice
|
.. bro:enum:: Example::Notice_Four Notice::Type
|
||||||
|
|
||||||
Public Interface
|
Public Interface
|
||||||
----------------
|
----------------
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue