Robert Ellis / FTPServer

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Files at this revision

API Documentation at this revision

Revision 1:f5789613b955, committed 2011-06-19

Comitter:
Phlaphead
Date:
Sun Jun 19 14:08:08 2011 +0000
Parent:
0:61dbbee3f903
Commit message:
added documentation

Changed in this revision

FTPRequestHandler.h Show annotated file Show diff for this revision Revisions of this file
FTPUser.h Show annotated file Show diff for this revision Revisions of this file 
diff -r 61dbbee3f903 -r f5789613b955 FTPRequestHandler.h
--- a/FTPRequestHandler.h	Sun Jun 19 13:59:16 2011 +0000
+++ b/FTPRequestHandler.h	Sun Jun 19 14:08:08 2011 +0000
@@ -39,9 +39,7 @@
 using std::string;
 
 
-/**
- * Enumeration of FTP command which require state to be remembered.
- */
+
 enum FtpCommand 
 { 
     NOOP, 
@@ -49,9 +47,7 @@
 };
 
 
-/**
- * Handles FTP commands comming from a client.
- */
+
 class FTPRequestHandler : public NetService
 {
 public:

diff -r 61dbbee3f903 -r f5789613b955 FTPUser.h
--- a/FTPUser.h	Sun Jun 19 13:59:16 2011 +0000
+++ b/FTPUser.h	Sun Jun 19 14:08:08 2011 +0000
@@ -6,17 +6,41 @@
 
 using namespace std;
 
+/**
+ * An FTP User.
+ */
 class FTPUser
 {
 public:
-
-    FTPUser();
+    
+    /**
+     * Constructor.
+     * @param username Username.
+     * @param password Password.
+     */
     FTPUser(char* username, char* password);
+    FTPUser();
     
+    /**
+     * Sets the username.
+     * @param username Username.
+     */
     void setUsername(const string& username) { m_username = username; }
+    
+    /**
+     * Sets the password.
+     * @param username Password.
+     */
     void setPassword(const string& password) { m_password = password; }
     
+    /**
+     * Get the username.
+     */
     string& getUsername() { return m_username; }
+    
+    /**
+     * Get the password.
+     */
     string& getPassword() { return m_password; }
     
 private: