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

Polishing, mostly documentation updates.

Browse source
This commit is contained in:
Robin Sommer 2014-06-17 11:50:23 -07:00
parent 551950c438
commit 60cf0ddf26
9 changed files with 294 additions and 179 deletions
Download patch file Download diff file Expand all files Collapse all files

13
src/plugin/Component.h
View file

@ -16,7 +16,7 @@ namespace component {
*/
enum Type {
READER, /// An input reader (not currently used).
WRITER, /// An logging writer (not currenly used).
WRITER, /// A logging writer (not currenly used).
ANALYZER, /// A protocol analyzer.
FILE_ANALYZER /// A file analyzer.
};
@ -59,17 +59,18 @@ public:
* Returns a textual representation of the component. This goes into
* the output of "bro -NN".
*
* By default version, this just outputs the type and the name.
* Derived versions should override DoDescribe() to add type specific
* details.
* By default, this just outputs the type and the name. Derived
* versions can override DoDescribe() to add type specific details.
*
* @param d The description object to use.
*/
virtual void Describe(ODesc* d) const;
void Describe(ODesc* d) const;
protected:
/**
* Adds type specific information to the outout of Describe().
* Adds type specific information to the outout of Describe().
*
* The default version does nothing.
*
* @param d The description object to use.
*/