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 enum documentation autogeneration.

Browse source 
This adds a new subclass of EnumType, CommentedEnumType, and removes
any previous changes to EnumType that were done to support the
autodoc framework.

Dummy CommentedEnumType and ID's are constructed in parallel with the
real EnumType ID's during parsing and passed on to the autodoc framework.

This allows the generated documentation to track enum redefs, with
a special case being the "Notice" enum type.
This commit is contained in:
Jon Siwek 2011-03-15 14:51:50 -05:00
parent b1dc5d3a1c
commit f67c0892e5
7 changed files with 107 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/BroDocObj.h
View file

@ -15,8 +15,10 @@ public:
* @param reST a reference to a pointer of a list of strings that
represent the reST documentation for the ID. The pointer
will be set to 0 after this constructor finishes.
* @param is_fake whether the ID* is a dummy just for doc purposes
*/
BroDocObj(const ID* id, std::list<std::string>*& reST);
BroDocObj(const ID* id, std::list<std::string>*& reST,
bool is_fake = false);
/**
* BroDocObj destructor
@ -60,6 +62,7 @@ public:
protected:
std::list<std::string>* reST_doc_strings;
const ID* broID;
bool is_fake_id; /**< Whether the ID* is a dummy just for doc purposes */
private:
};