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

Tabifying BroDoc* sources to make consistent with general style.

Browse source
This commit is contained in:
Jon Siwek 2011-03-15 16:48:51 -05:00
parent dbf2b9996e
commit 9e13d15f29
4 changed files with 399 additions and 399 deletions
Download patch file Download diff file Expand all files Collapse all files

78
src/BroDocObj.h
View file

@ -9,51 +9,51 @@
class BroDocObj {
public:
/**
* BroDocObj constructor
* @param id a pointer to an identifier that is to be documented
* @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,
bool is_fake = false);
/**
* BroDocObj constructor
* @param id a pointer to an identifier that is to be documented
* @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,
bool is_fake = false);
/**
* BroDocObj destructor
* Deallocates the memory associated with the list of reST strings
*/
~BroDocObj();
/**
* BroDocObj destructor
* Deallocates the memory associated with the list of reST strings
*/
~BroDocObj();
/**
* Writes the reST representation of this object which includes
* 1) Any "##" or "##<" stylized comments.
* Anything after these style of comments is inserted as-is into
* the reST document.
* 2) a reST friendly description of the ID
* @param The (already opened) file to write the reST to.
*/
void WriteReST(FILE* file) const;
/**
* Writes the reST representation of this object which includes
* 1) Any "##" or "##<" stylized comments.
* Anything after these style of comments is inserted as-is into
* the reST document.
* 2) a reST friendly description of the ID
* @param The (already opened) file to write the reST to.
*/
void WriteReST(FILE* file) const;
/**
* Check whether this documentation is part of the public API
* (The declaration was while in an export section).
* @return true if the ID was declared in an export section, else false
*/
bool IsPublicAPI() const { return broID->IsExport(); }
/**
* Check whether this documentation is part of the public API
* (The declaration was while in an export section).
* @return true if the ID was declared in an export section, else false
*/
bool IsPublicAPI() const { return broID->IsExport(); }
/**
* Return whether this object has documentation (## comments)
* @return true if the ID has comments associated with it
*/
bool HasDocumentation() const { return reST_doc_strings &&
reST_doc_strings->size() > 0; }
/**
* Return whether this object has documentation (## comments)
* @return true if the ID has comments associated with it
*/
bool HasDocumentation() const { return reST_doc_strings &&
reST_doc_strings->size() > 0; }
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 */
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:
};