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

Another revision for autodoc tracking of public vs private interfaces

Browse source 
A script's public API wasn't simply definable as identifiers
for which ID::IsGlobal() is true, e.g. an unexported identifier with
SCOPE_MODULE will still pass that test and (incorrectly) be considered
public API.

Also, generated reST now omits empty interface sections.
This commit is contained in:
Jon Siwek 2011-03-24 14:04:30 -05:00
parent 2e88c5100c
commit 2490878656
4 changed files with 31 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/BroDocObj.h
View file

@ -41,9 +41,9 @@ public:
* 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
* @return true if the identifier is part of the script's public API
*/
bool IsPublicAPI() const { return broID->IsGlobal(); }
bool IsPublicAPI() const;
/**
* Return whether this object has documentation (## comments)