summaryrefslogtreecommitdiff
path: root/other/apidsl/tox.in.h
diff options
context:
space:
mode:
Diffstat (limited to 'other/apidsl/tox.in.h')
-rw-r--r--other/apidsl/tox.in.h18
1 files changed, 17 insertions, 1 deletions
diff --git a/other/apidsl/tox.in.h b/other/apidsl/tox.in.h
index 30c78e44..4a0ab950 100644
--- a/other/apidsl/tox.in.h
+++ b/other/apidsl/tox.in.h
@@ -34,6 +34,14 @@ extern "C" {
34#endif 34#endif
35%} 35%}
36 36
37
38/*****************************************************************************
39 * `tox.h` SHOULD *NOT* BE EDITED MANUALLY – any changes should be made to *
40 * `tox.in.h`, located in `other/apidsl/`. For instructions on how to *
41 * generate `tox.h` from `tox.in.h` please refer to `other/apidsl/README.md` *
42 *****************************************************************************/
43
44
37/** \page core Public core API for Tox clients. 45/** \page core Public core API for Tox clients.
38 * 46 *
39 * Every function that can fail takes a function-specific error code pointer 47 * Every function that can fail takes a function-specific error code pointer
@@ -431,7 +439,15 @@ static class options {
431 uint16_t end_port; 439 uint16_t end_port;
432 440
433 /** 441 /**
434 * The port to use for the TCP server. If 0, the tcp server is disabled. 442 * The port to use for the TCP server (relay). If 0, the TCP server is
443 * disabled.
444 *
445 * Enabling it is not required for Tox to function properly.
446 *
447 * When enabled, your Tox instance can act as a TCP relay for other Tox
448 * instance. This leads to increased traffic, thus when writing a client
449 * it is recommended to enable TCP server only if the user has an option
450 * to disable it.
435 */ 451 */
436 uint16_t tcp_port; 452 uint16_t tcp_port;
437 453