summaryrefslogtreecommitdiff
path: root/other/apidsl
diff options
context:
space:
mode:
authorZetok Zalbavar <zexavexxe@gmail.com>2015-06-17 10:38:53 +0100
committerZetok Zalbavar <zexavexxe@gmail.com>2015-06-20 01:08:43 +0100
commit4ffd5584f9dcbd5ed321239c1d78a852fafdc0b8 (patch)
tree1e74988c45d829f0a32a54b788d513bc18a2d45c /other/apidsl
parent67df1ab7ce6b6cb8103ddf73df814f685240a59c (diff)
Improve documentation about tcp_port
Apparently it's not entirely clear that it's not needed in clients. v2, as provided by @nurupo
Diffstat (limited to 'other/apidsl')
-rw-r--r--other/apidsl/tox.in.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/other/apidsl/tox.in.h b/other/apidsl/tox.in.h
index 30c78e44..493dd18e 100644
--- a/other/apidsl/tox.in.h
+++ b/other/apidsl/tox.in.h
@@ -431,7 +431,15 @@ static class options {
431 uint16_t end_port; 431 uint16_t end_port;
432 432
433 /** 433 /**
434 * The port to use for the TCP server. If 0, the tcp server is disabled. 434 * The port to use for the TCP server (relay). If 0, the TCP server is
435 * disabled.
436 *
437 * Enabling it is not required for Tox to function properly.
438 *
439 * When enabled, your Tox instance can act as a TCP relay for other Tox
440 * instance. This leads to increased traffic, thus when writing a client
441 * it is recommended to enable TCP server only if the user has an option
442 * to disable it.
435 */ 443 */
436 uint16_t tcp_port; 444 uint16_t tcp_port;
437 445