Skip to content

Commit c76598a

Browse files
committed
Minor doc fixes.
1 parent d2340b5 commit c76598a

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

src/PEAR2/Net/RouterOS/Client.php

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,16 +103,18 @@ class Client
103103
* @param string $password The RouterOS password.
104104
* @param int|null $port The port on which the RouterOS server provides
105105
* the API service. You can also specify NULL, in which case the port
106-
* will automatically be chosen between 8728 and 8729, depending on your
107-
* encryption setting.
106+
* will automatically be chosen between 8728 and 8729, depending on the
107+
* value of $crypto.
108108
* @param bool $persist Whether or not the connection should be a
109109
* persistent one.
110110
* @param float $timeout The timeout for the connection.
111111
* @param string $crypto The encryption for this connection. Must be one
112112
* of the PEAR2\Net\Transmitter\NetworkStream::CRYPTO_* constants. Off
113-
* by default. For the sake of simplicity, if you specify an encryption,
114-
* don't specify a context and your default context uses the value
115-
* "DEFAULT" for ciphers, "ADH" will be automatically added to the list.
113+
* by default. RouterOS currently supports only TLS, but the setting is
114+
* provided in this fashion for forward compatibility's sake. And for
115+
* the sake of simplicity, if you specify an encryption, don't specify a
116+
* context and your default context uses the value "DEFAULT" for
117+
* ciphers, "ADH" will be automatically added to the list of ciphers.
116118
* @param resource $context A context for the socket.
117119
*
118120
* @see sendSync()

src/PEAR2/Net/RouterOS/Communicator.php

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,18 +92,20 @@ class Communicator
9292
* @param string $host Hostname (IP or domain) of the RouterOS server.
9393
* @param int|null $port The port on which the RouterOS server provides
9494
* the API service. You can also specify NULL, in which case the port
95-
* will automatically be chosen between 8728 and 8729, depending on your
96-
* encryption setting.
95+
* will automatically be chosen between 8728 and 8729, depending on the
96+
* value of $crypto.
9797
* @param bool $persist Whether or not the connection should be a
9898
* persistent one.
9999
* @param float $timeout The timeout for the connection.
100100
* @param string $key A string that uniquely identifies the
101101
* connection.
102102
* @param string $crypto The encryption for this connection. Must be one
103103
* of the PEAR2\Net\Transmitter\NetworkStream::CRYPTO_* constants. Off
104-
* by default. For the sake of simplicity, if you specify an encryption,
105-
* don't specify a context and your default context uses the value
106-
* "DEFAULT" for ciphers, "ADH" will be automatically added to the list.
104+
* by default. RouterOS currently supports only TLS, but the setting is
105+
* provided in this fashion for forward compatibility's sake. And for
106+
* the sake of simplicity, if you specify an encryption, don't specify a
107+
* context and your default context uses the value "DEFAULT" for
108+
* ciphers, "ADH" will be automatically added to the list of ciphers.
107109
* @param resource $context A context for the socket.
108110
*
109111
* @see sendWord()

0 commit comments

Comments
 (0)