Diff: FTPUser.h

Revision:

1:f5789613b955

Parent:

0:61dbbee3f903

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: