diff --git a/src/analyzer/protocol/ftp/functions.bif b/src/analyzer/protocol/ftp/functions.bif index a667d8ca88..b57b24df20 100644 --- a/src/analyzer/protocol/ftp/functions.bif +++ b/src/analyzer/protocol/ftp/functions.bif @@ -116,11 +116,12 @@ static Val* parse_eftp(const char* line) } %%} -## Converts a string representation of the FTP PORT command to an ``ftp_port``. +## Converts a string representation of the FTP PORT command to an +## :bro:type:`ftp_port`. ## ## s: The string of the FTP PORT command, e.g., ``"10,0,0,1,4,31"``. ## -## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]`` +## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]``. ## ## .. bro:see:: parse_eftp_port parse_ftp_pasv parse_ftp_epsv fmt_ftp_port function parse_ftp_port%(s: string%): ftp_port @@ -128,14 +129,14 @@ function parse_ftp_port%(s: string%): ftp_port return parse_port(s->CheckString()); %} -## Converts a string representation of the FTP EPRT command to an ``ftp_port``. -## See `RFC 2428 `_. -## The format is ``EPRT``, +## Converts a string representation of the FTP EPRT command (see :rfc:`2428`) +## to an :bro:type:`ftp_port`. The format is +## ``"EPRT"``, ## where ```` is a delimiter in the ASCII range 33-126 (usually ``|``). ## ## s: The string of the FTP EPRT command, e.g., ``"|1|10.0.0.1|1055|"``. ## -## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]`` +## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]``. ## ## .. bro:see:: parse_ftp_port parse_ftp_pasv parse_ftp_epsv fmt_ftp_port function parse_eftp_port%(s: string%): ftp_port @@ -143,11 +144,11 @@ function parse_eftp_port%(s: string%): ftp_port return parse_eftp(s->CheckString()); %} -## Converts the result of the FTP PASV command to an ``ftp_port``. +## Converts the result of the FTP PASV command to an :bro:type:`ftp_port`. ## ## str: The string containing the result of the FTP PASV command. ## -## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]`` +## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]``. ## ## .. bro:see:: parse_ftp_port parse_eftp_port parse_ftp_epsv fmt_ftp_port function parse_ftp_pasv%(str: string%): ftp_port @@ -168,14 +169,13 @@ function parse_ftp_pasv%(str: string%): ftp_port return parse_port(line); %} -## Converts the result of the FTP EPSV command to an ``ftp_port``. -## See `RFC 2428 `_. -## The format is `` ()``, where ```` is a -## delimiter in the ASCII range 33-126 (usually ``|``). +## Converts the result of the FTP EPSV command (see :rfc:`2428`) to an +## :bro:type:`ftp_port`. The format is ``" ()"``, +## where ```` is a delimiter in the ASCII range 33-126 (usually ``|``). ## ## str: The string containing the result of the FTP EPSV command. ## -## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]`` +## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]``. ## ## .. bro:see:: parse_ftp_port parse_eftp_port parse_ftp_pasv fmt_ftp_port function parse_ftp_epsv%(str: string%): ftp_port diff --git a/src/analyzer/protocol/tcp/functions.bif b/src/analyzer/protocol/tcp/functions.bif index f5b0033ae8..9fca05329a 100644 --- a/src/analyzer/protocol/tcp/functions.bif +++ b/src/analyzer/protocol/tcp/functions.bif @@ -93,13 +93,12 @@ function get_gap_summary%(%): gap_info ## ## - ``CONTENTS_NONE``: Stop recording the connection's content. ## - ``CONTENTS_ORIG``: Record the data sent by the connection -## originator (often the client). +## originator (often the client). ## - ``CONTENTS_RESP``: Record the data sent by the connection -## responder (often the server). +## responder (often the server). ## - ``CONTENTS_BOTH``: Record the data sent in both directions. -## Results in the two directions being -## intermixed in the file, in the order the -## data was seen by Bro. +## Results in the two directions being intermixed in the file, +## in the order the data was seen by Bro. ## ## f: The file handle of the file to write the contents to. ##