From 5068b8b293425ca40f48951ab93bce2789638ab5 Mon Sep 17 00:00:00 2001
From: Larpon <Larpon@users.noreply.github.com>
Date: Mon, 16 May 2022 07:52:12 +0200
Subject: [PATCH] ftp: document all public methods (#14408)

---
 vlib/net/ftp/ftp.v | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/vlib/net/ftp/ftp.v b/vlib/net/ftp/ftp.v
index f397da3e0..c6c1c0631 100644
--- a/vlib/net/ftp/ftp.v
+++ b/vlib/net/ftp/ftp.v
@@ -66,6 +66,7 @@ mut:
 	buffer_size int
 }
 
+// new returns an `FTP` instance.
 pub fn new() FTP {
 	mut f := FTP{
 		conn: 0
@@ -101,6 +102,7 @@ fn (mut zftp FTP) read() ?(int, string) {
 	return code, data
 }
 
+// connect establishes an FTP connection to the host at `ip` port 21.
 pub fn (mut zftp FTP) connect(ip string) ?bool {
 	zftp.conn = net.dial_tcp('$ip:21')?
 	zftp.reader = io.new_buffered_reader(reader: zftp.conn)
@@ -111,6 +113,7 @@ pub fn (mut zftp FTP) connect(ip string) ?bool {
 	return false
 }
 
+// login sends the "USER `user`" and "PASS `passwd`" commands to the remote host.
 pub fn (mut zftp FTP) login(user string, passwd string) ?bool {
 	zftp.write('USER $user') or {
 		$if debug {
@@ -138,11 +141,13 @@ pub fn (mut zftp FTP) login(user string, passwd string) ?bool {
 	return false
 }
 
+// close closes the FTP connection.
 pub fn (mut zftp FTP) close() ? {
 	zftp.write('QUIT')?
 	zftp.conn.close()?
 }
 
+// pwd returns the current working directory on the remote host for the logged in user.
 pub fn (mut zftp FTP) pwd() ?string {
 	zftp.write('PWD')?
 	_, data := zftp.read()?
@@ -153,6 +158,7 @@ pub fn (mut zftp FTP) pwd() ?string {
 	return data
 }
 
+// cd changes the current working directory to the specified remote directory `dir`.
 pub fn (mut zftp FTP) cd(dir string) ? {
 	zftp.write('CWD $dir') or { return }
 	mut code, mut data := zftp.read()?
@@ -201,6 +207,7 @@ fn (mut zftp FTP) pasv() ?&DTP {
 	return dtp
 }
 
+// dir returns a list of the files in the current working directory.
 pub fn (mut zftp FTP) dir() ?[]string {
 	mut dtp := zftp.pasv() or { return error('Cannot establish data connection') }
 	zftp.write('LIST')?
@@ -227,6 +234,7 @@ pub fn (mut zftp FTP) dir() ?[]string {
 	return dir
 }
 
+// get retrieves `file` from the remote host.
 pub fn (mut zftp FTP) get(file string) ?[]u8 {
 	mut dtp := zftp.pasv() or { return error('Cannot stablish data connection') }
 	zftp.write('RETR $file')?
-- 
2.30.2