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

Update to auto-generated documentation format.

Browse source 
Comments are now clearly marked.

Enums are now documented in order of their integral value, not
their identifier string.
This commit is contained in:
Jon Siwek 2011-03-14 14:49:58 -05:00
parent f47c8e4d93
commit b1dc5d3a1c
2 changed files with 27 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

23
src/BroDocObj.cc
View file

@ -18,16 +18,19 @@ BroDocObj::~BroDocObj()
void BroDocObj::WriteReST(FILE* file) const
{
if ( reST_doc_strings )
{
std::list<std::string>::const_iterator it;
for ( it = reST_doc_strings->begin();
it != reST_doc_strings->end(); ++it)
fprintf(file, "%s\n", it->c_str());
}
ODesc desc;
desc.SetQuotes(1);
broID->DescribeReST(&desc);
fprintf(file, "%s\n\n", desc.Description());
}
fprintf(file, "%s\n", desc.Description());
if ( HasDocumentation() )
{
fprintf(file, "\t.. bro:comment::\n");
std::list<std::string>::const_iterator it;
for ( it = reST_doc_strings->begin();
it != reST_doc_strings->end(); ++it)
fprintf(file, "\t\t%s\n", it->c_str());
}
fprintf(file, "\n");
}