summaryrefslogtreecommitdiff
path: root/apps/include/ftpc.h
diff options
context:
space:
mode:
Diffstat (limited to 'apps/include/ftpc.h')
-rw-r--r--apps/include/ftpc.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/apps/include/ftpc.h b/apps/include/ftpc.h
index 211edbad4..0676a7040 100644
--- a/apps/include/ftpc.h
+++ b/apps/include/ftpc.h
@@ -112,7 +112,14 @@
typedef FAR void *SESSION;
-/* This structure provides information to connect to a host FTP server */
+/* This structure provides information to connect to a host FTP server.
+ *
+ * addr - The IPv4 address of the FTP server (or the proxy) for the FTP
+ * server.
+ * port - The port number on the FTP server to connect to. This is usually
+ * port 21 for FTP. You may set this value to zero to let FTPC
+ * select the default port number for you (CONFIG_FTP_DEFPORT).
+ */
struct ftpc_connect_s
{