Fix a number of documentation building errors

This commit is contained in:
Johanna Amann 2016-06-27 12:41:40 -07:00
parent 94e242f2fd
commit 971f7e236f
5 changed files with 39 additions and 41 deletions

View file

@ -9,7 +9,7 @@ module Pcap;
##
## Returns: True if *s* is valid and precompiles successfully.
##
## .. bro:see:: install_pcap_filter
## .. bro:see:: Pcap::install_pcap_filter
## install_src_addr_filter
## install_src_net_filter
## uninstall_src_addr_filter
@ -18,7 +18,7 @@ module Pcap;
## install_dst_net_filter
## uninstall_dst_addr_filter
## uninstall_dst_net_filter
## pcap_error
## Pcap::error
function precompile_pcap_filter%(id: PcapFilterID, s: string%): bool
%{
if ( id->AsEnum() >= 100 )
@ -48,14 +48,14 @@ function precompile_pcap_filter%(id: PcapFilterID, s: string%): bool
%}
## Installs a PCAP filter that has been precompiled with
## :bro:id:`precompile_pcap_filter`.
## :bro:id:`Pcap::precompile_pcap_filter`.
##
## id: The PCAP filter id of a precompiled filter.
##
## Returns: True if the filter associated with *id* has been installed
## successfully.
##
## .. bro:see:: precompile_pcap_filter
## .. bro:see:: Pcap::precompile_pcap_filter
## install_src_addr_filter
## install_src_net_filter
## uninstall_src_addr_filter
@ -64,8 +64,8 @@ function precompile_pcap_filter%(id: PcapFilterID, s: string%): bool
## install_dst_net_filter
## uninstall_dst_addr_filter
## uninstall_dst_net_filter
## pcap_error
function install_pcap_filter%(id: PcapFilterID%): bool
## Pcap::error
function Pcap::install_pcap_filter%(id: PcapFilterID%): bool
%{
bool success = true;
@ -87,8 +87,8 @@ function install_pcap_filter%(id: PcapFilterID%): bool
##
## Returns: A descriptive error message of the PCAP function that failed.
##
## .. bro:see:: precompile_pcap_filter
## install_pcap_filter
## .. bro:see:: Pcap::precompile_pcap_filter
## Pcap::install_pcap_filter
## install_src_addr_filter
## install_src_net_filter
## uninstall_src_addr_filter