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

Removing lexical scanner recognition of "## Author:" comments.

Browse source 
This functionality is better done manually by the script writer
embedding reST into the script summary section (##! comments).
This allows flexibility in choosing between different methods
to convey the same information (e.g. ":Author: <author>" or
the ".. codeauthor:: <author>" directive that Sphinx
configurations can recognize).
This commit is contained in:
Jon Siwek 2011-03-24 09:51:47 -05:00
parent 8b79971e21
commit c2f0332b5f
3 changed files with 0 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/BroDoc.h
View file

@ -83,13 +83,6 @@ public:
*/
void AddPortAnalysis(const std::string& analyzer, const std::string& ports);
/**
* Adds a script author.
* The scanner should call this when it sees "## Author: ..."
* @param s The name, email, etc. of the script author.
*/
void AddAuthor(const std::string& s) { authors.push_back(s); }
/**
* Schedules documentation of a script option. An option is
* defined as any variable in the script that is declared 'const'
@ -168,7 +161,6 @@ protected:
std::string source_filename;
std::string packet_filter;
std::list<std::string> authors;
std::list<std::string> modules;
std::list<std::string> summary;
std::list<std::string> imports;