summaryrefslogtreecommitdiff
path: root/toxcore
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 /toxcore
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 'toxcore')
-rw-r--r--toxcore/tox.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/toxcore/tox.h b/toxcore/tox.h
index 14c9f616..5af92c72 100644
--- a/toxcore/tox.h
+++ b/toxcore/tox.h
@@ -451,7 +451,15 @@ struct Tox_Options {
451 451
452 452
453 /** 453 /**
454 * The port to use for the TCP server. If 0, the tcp server is disabled. 454 * The port to use for the TCP server (relay). If 0, the TCP server is
455 * disabled.
456 *
457 * Enabling it is not required for Tox to function normally.
458 *
459 * When enabled, your Tox instance can act as a TCP relay for other Tox
460 * instance. This leads to increased traffic, thus when writing a client
461 * it is recommended to enable TCP server only if the user has an option
462 * to disable it.
455 */ 463 */
456 uint16_t tcp_port; 464 uint16_t tcp_port;
457 465