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

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 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; ODesc desc;
desc.SetQuotes(1); desc.SetQuotes(1);
broID->DescribeReST(&desc); 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");
}

18
src/Type.cc
View file

@ -1067,6 +1067,7 @@ void RecordType::DescribeFieldsReST(ODesc* d, bool func_args) const
if ( td->comment ) if ( td->comment )
{ {
d->PushIndent(); d->PushIndent();
d->Add(".. bro:comment:: ");
d->Add(td->comment); d->Add(td->comment);
d->PopIndent(); d->PopIndent();
} }
@ -1345,20 +1346,29 @@ const char* EnumType::Lookup(bro_int_t value)
void EnumType::DescribeReST(ODesc* d) const void EnumType::DescribeReST(ODesc* d) const
{ {
// create temporary, reverse name map so that enums can be documented
// in ascending order of their actual integral value instead of by name
typedef std::map< bro_int_t, const char* > RevNameMap;
RevNameMap rev;
for ( NameMap::const_iterator it = names.begin(); it != names.end(); ++it )
rev[it->second] = it->first;
d->Add(type_name(Tag())); d->Add(type_name(Tag()));
d->PushIndent(); d->PushIndent();
for ( NameMap::const_iterator it = names.begin(); it != names.end(); )
for ( RevNameMap::const_iterator it = rev.begin(); it != rev.end(); )
{ {
d->Add(".. bro:enum:: "); d->Add(".. bro:enum:: ");
d->Add(it->first); d->Add(it->second);
CommentMap::const_iterator cmnt_it = comments.find(it->first); CommentMap::const_iterator cmnt_it = comments.find(it->second);
if ( cmnt_it != comments.end() ) if ( cmnt_it != comments.end() )
{ {
d->PushIndent(); d->PushIndent();
d->Add(".. bro:comment:: ");
d->Add(cmnt_it->second); d->Add(cmnt_it->second);
d->PopIndent(); d->PopIndent();
} }
if ( ++it != names.end() ) if ( ++it != rev.end() )
d->NL(); d->NL();
} }
} }