Merge branch 'doc' of https://github.com/zetok/ProjectTox-Core

1 files changed, 9 insertions, 1 deletions

diff --git a/other/apidsl/tox.in.h b/other/apidsl/tox.in.h
index 189fc43d..4a0ab950 100644
--- a/other/apidsl/tox.in.h
+++ b/other/apidsl/tox.in.h
@@ -439,7 +439,15 @@ static class options {
     uint16_t end_port;
 
     /**
-     * The port to use for the TCP server. If 0, the tcp server is disabled.
+     * The port to use for the TCP server (relay). If 0, the TCP server is
+     * disabled.
+     *
+     * Enabling it is not required for Tox to function properly.
+     *
+     * When enabled, your Tox instance can act as a TCP relay for other Tox
+     * instance. This leads to increased traffic, thus when writing a client
+     * it is recommended to enable TCP server only if the user has an option
+     * to disable it.
      */
     uint16_t tcp_port;