Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-02 14:48:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add brief descriptions for classes involved in generation of script docs.

Browse source
This commit is contained in:
Jon Siwek 2011-04-08 12:30:06 -05:00
parent af54714839
commit 057ad684d8
2 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/BroDoc.h
View file

@ -8,6 +8,10 @@
#include "BroDocObj.h" #include "BroDocObj.h"
/**
* This class is used to gather all data relevant to the automatic generation
* of a reStructuredText (reST) document from a given Bro script.
*/
class BroDoc { class BroDoc {
public: public:
/** /**

5
src/BroDocObj.h
View file

@ -7,6 +7,10 @@
#include "ID.h" #include "ID.h"
/**
* This class wraps a Bro script identifier, providing methods relevant
* to automatic generation of reStructuredText (reST) documentation for it.
*/
class BroDocObj { class BroDocObj {
public: public:
/** /**
@ -97,7 +101,6 @@ public:
*/ */
int LongestShortDescLen() const; int LongestShortDescLen() const;
protected: protected:
std::list<std::string>* reST_doc_strings; std::list<std::string>* reST_doc_strings;
std::list<std::string> short_desc; std::list<std::string> short_desc;