Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-15 21:18: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/BroDocObj.h
View file

@ -37,11 +37,13 @@ public:
void WriteReST(FILE* file) const;
/**
* Check whether this documentation is part of the public API
* (The declaration was while in an export section).
* Check whether this documentation is part of the public API. In
* other words, this means that the identifier is declared as part of
* the global scope (has GLOBAL namespace or is exported from another
* namespace).
* @return true if the ID was declared in an export section, else false
*/
bool IsPublicAPI() const { return broID->IsExport(); }
bool IsPublicAPI() const { return broID->IsGlobal(); }
/**
* Return whether this object has documentation (## comments)