mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 14:48:21 +00:00
Add brief descriptions for classes involved in generation of script docs.
This commit is contained in:
parent
af54714839
commit
057ad684d8
2 changed files with 8 additions and 1 deletions
|
@ -8,6 +8,10 @@
|
|||
|
||||
#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 {
|
||||
public:
|
||||
/**
|
||||
|
|
|
@ -7,6 +7,10 @@
|
|||
|
||||
#include "ID.h"
|
||||
|
||||
/**
|
||||
* This class wraps a Bro script identifier, providing methods relevant
|
||||
* to automatic generation of reStructuredText (reST) documentation for it.
|
||||
*/
|
||||
class BroDocObj {
|
||||
public:
|
||||
/**
|
||||
|
@ -97,7 +101,6 @@ public:
|
|||
*/
|
||||
int LongestShortDescLen() const;
|
||||
|
||||
|
||||
protected:
|
||||
std::list<std::string>* reST_doc_strings;
|
||||
std::list<std::string> short_desc;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue