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

Revising notice, port analysis, packet filter, auto-generated documentation.

Browse source 
They're now all optional sections -- if a given bro script doesn't use the
functionality, then the documentation doesn't mention anything about it.
This commit is contained in:
Jon Siwek 2011-03-21 15:08:39 -05:00
parent e0a77cb794
commit 384fa03c26
2 changed files with 56 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

15
src/BroDoc.h
View file

@ -122,7 +122,7 @@ public:
* Bro language representation of the Notice and also
* any associated comments about it.
*/
void AddNotice(const BroDocObj* o) { notices = o; }
void AddNotice(const BroDocObj* o) { notices.push_back(o); }
/**
* Schedules documentation of an event declared by the script.
@ -176,7 +176,7 @@ protected:
std::list<const BroDocObj*> options;
std::list<const BroDocObj*> state_vars;
std::list<const BroDocObj*> types;
const BroDocObj* notices;
std::list<const BroDocObj*> notices;
std::list<const BroDocObj*> events;
std::list<const BroDocObj*> functions;
std::list<const BroDocObj*> redefs;
@ -217,6 +217,17 @@ protected:
const char* heading,
char underline) const;
/**
* Writes out a list of BroDocObj objects to the reST document
* @param l A list of BroDocObj pointers
* @param heading The title of the section to create in the reST doc.
* @param underline The character to use to underline the reST
* section heading.
*/
void WriteBroDocObjList(const std::list<const BroDocObj*>& l,
const char* heading,
char underline) const;
/**
* A wrapper to fprintf() that always uses the reST document
* for the FILE* argument.