Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-03 23:28:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Revise autodoc tracking of public vs private script interfaces

Browse source 
A bro script's public interface is taken to mean any identifier declared
in the global scope that optionally is exported from some namespace/module.
Or more simply: ID::IsGlobal()
This commit is contained in:
Jon Siwek 2011-03-24 12:32:32 -05:00
parent c2f0332b5f
commit 2e88c5100c
4 changed files with 20 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/BroDoc.h
View file

@ -198,15 +198,15 @@ protected:
/**
* Writes out a list of BroDocObj objects to the reST document
* @param l A list of BroDocObj pointers
* @param exportCond If true, filter out objects that are not in an
* export section. If false, filter out those that are in
* an export section.
* @param wantPublic If true, filter out objects that are not declared
* in the global scope. If false, filter out those that are in
* the global scope.
* @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,
bool exportCond,
bool wantPublic,
const char* heading,
char underline) const;