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

Move generated script doc for "private interface" to bottom of page.

Browse source
This commit is contained in:
Jon Siwek 2011-04-11 09:59:45 -05:00
parent 552a70c563
commit 0a14cd11f6
2 changed files with 32 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

24
src/BroDoc.cc
View file

@ -128,18 +128,6 @@ void BroDoc::WriteDocFile() const
WriteInterface("Public Interface", '-', '~', true, false); WriteInterface("Public Interface", '-', '~', true, false);
BroDocObjList::const_iterator it;
bool hasPrivateIdentifiers = false;
for ( it = all.begin(); it != all.end(); ++it )
if ( ! IsPublicAPI(*it) )
{
hasPrivateIdentifiers = true;
break;
}
if ( hasPrivateIdentifiers )
WriteInterface("Private Interface", '-', '~', false, false);
if ( ! port_analysis.empty() ) if ( ! port_analysis.empty() )
{ {
WriteSectionHeading("Port Analysis", '-'); WriteSectionHeading("Port Analysis", '-');
@ -154,6 +142,18 @@ void BroDoc::WriteDocFile() const
WriteToDoc("Filters added::\n\n"); WriteToDoc("Filters added::\n\n");
WriteToDoc("%s\n", packet_filter.c_str()); WriteToDoc("%s\n", packet_filter.c_str());
} }
BroDocObjList::const_iterator it;
bool hasPrivateIdentifiers = false;
for ( it = all.begin(); it != all.end(); ++it )
if ( ! IsPublicAPI(*it) )
{
hasPrivateIdentifiers = true;
break;
}
if ( hasPrivateIdentifiers )
WriteInterface("Private Interface", '-', '~', false, false);
} }
void BroDoc::WriteInterface(const char* heading, char underline, void BroDoc::WriteInterface(const char* heading, char underline,

40
testing/btest/Baseline/doc.autogen-reST-example/example.rst
View file

@ -227,6 +227,26 @@ Redefinitions
document the "SimpleEnum" redef here document the "SimpleEnum" redef here
Port Analysis
-------------
:ref:`More Information <common_port_analysis_doc>`
SSL::
[ports={
443/tcp,
563/tcp
}]
Packet Filter
-------------
:ref:`More Information <common_packet_filter_doc>`
Filters added::
[ssl] = tcp port 443,
[nntps] = tcp port 563
Private Interface Private Interface
----------------- -----------------
State Variables State Variables
@ -260,23 +280,3 @@ Functions
:Type: :bro:type:`function` (tag: :bro:type:`string`) : :bro:type:`string` :Type: :bro:type:`function` (tag: :bro:type:`string`) : :bro:type:`string`
Port Analysis
-------------
:ref:`More Information <common_port_analysis_doc>`
SSL::
[ports={
443/tcp,
563/tcp
}]
Packet Filter
-------------
:ref:`More Information <common_packet_filter_doc>`
Filters added::
[ssl] = tcp port 443,
[nntps] = tcp port 563