diff options
author | Zetok Zalbavar <zexavexxe@gmail.com> | 2015-06-17 10:38:53 +0100 |
---|---|---|
committer | Zetok Zalbavar <zexavexxe@gmail.com> | 2015-06-20 01:08:43 +0100 |
commit | 4ffd5584f9dcbd5ed321239c1d78a852fafdc0b8 (patch) | |
tree | 1e74988c45d829f0a32a54b788d513bc18a2d45c | |
parent | 67df1ab7ce6b6cb8103ddf73df814f685240a59c (diff) |
Improve documentation about tcp_port
Apparently it's not entirely clear that it's not needed in clients.
v2, as provided by @nurupo
-rw-r--r-- | other/apidsl/tox.in.h | 10 | ||||
-rw-r--r-- | toxcore/tox.h | 10 |
2 files changed, 18 insertions, 2 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 | ||
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 | ||