Author: mordante
Date: Sun Sep 21 09:31:58 2008
New Revision: 29607
URL: http://svn.gna.org/viewcvs/wesnoth?rev=29607&view=rev
Log:
Update doxygen comment style.
Modified:
trunk/src/server/user_handler.hpp
Modified: trunk/src/server/user_handler.hpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/server/user_handler.hpp?rev=29607&r1=29606&r2=29607&view=diff
==============================================================================
--- trunk/src/server/user_handler.hpp (original)
+++ trunk/src/server/user_handler.hpp Sun Sep 21 09:31:58 2008
@@ -35,9 +35,11 @@
#define LOG_UH LOG_STREAM(info, mp_user_handler)
#define DBG_UH LOG_STREAM(debug, mp_user_handler)
-//! @class An interface class to handle nick registration
-//! To activate it put a [user_handler] section into the
-//! server configuration file
+/**
+ * @class An interface class to handle nick registration
+ * To activate it put a [user_handler] section into the
+ * server configuration file
+ */
class user_handler {
@@ -50,74 +52,104 @@
public:
virtual ~user_handler() {}
- //! Adds a user.
- //! Throws an error containing the error message if adding fails
- //! (e.g. because a user with the same name already exists).
+ /**
+ * Adds a user.
+ *
+ * Throws an error containing the error message if adding fails
+ * (e.g. because a user with the same name already exists).
+ */
virtual void add_user(const std::string& name, const
std::string& mail, const std::string& password) =0;
- //! Removes a user.
- //! Throws an error containing the error message if removing
fails
- //! (e.g. no user with the given name exists).
+ /**
+ * Removes a user.
+ *
+ * Throws an error containing the error message if removing
fails
+ * (e.g. no user with the given name exists).
+ */
virtual void remove_user(const std::string& name) =0;
- //! Called by the server once a day
- //! Could for example be used for removing users that have not
- //! logged in for a certain amount of time
+ /**
+ * Called by the server once a day.
+ *
+ * Could for example be used for removing users that have not
logged in
+ * for a certain amount of time.
+ */
virtual void clean_up() =0;
- //! Send a password reminder email to the given user
- //! Should throw user_handler::error if sending fails
- //! (e.g. because we cannot send email).
+ /**
+ * Send a password reminder email to the given user.
+ *
+ * Should throw user_handler::error if sending fails
+ * (e.g. because we cannot send email).
+ */
virtual void password_reminder(const std::string& name) =0;
- //! Return true if the given password matches the password for
the given user
- //! Password could also be a hash
- //! Seed is not needed for clear text log ins
- //! Currently the login procedure in the server and client code
is hardcoded
- //! for the forum_user_handler implementation
+ /**
+ * Return true if the given password matches the password for
the given user.
+ *
+ * Password could also be a hash
+ * Seed is not needed for clear text log ins
+ * Currently the login procedure in the server and client code
is hardcoded
+ * for the forum_user_handler implementation
+ */
virtual bool login(const std::string& name, const std::string&
password, const std::string& seed) =0;
- //! Executed when the user with the given name logged in
+ /** Executed when the user with the given name logged in. */
virtual void user_logged_in(const std::string& name) =0;
- //! Returns a string containing info like the last login of
this user
- //! formatted for user readable output
+ /**
+ * Returns a string containing info like the last login of this
user.
+ *
+ * Formatted for user readable output.
+ */
virtual std::string user_info(const std::string& name) =0;
- //! Set data for a given user name
- //! Should throw an error on invalid data
+ /**
+ * Set data for a given user name.
+ *
+ * Should throw an error on invalid data.
+ */
virtual void set_user_detail(const std::string& user, const
std::string& detail, const std::string& value) =0;
- //! List of details that can be set for this user_handler
+ /** List of details that can be set for this user_handler. */
virtual std::string get_valid_details() =0;
- //! Returns true if a user with the given name exists
+ /** Returns true if a user with the given name exists. */
virtual bool user_exists(const std::string& name) =0;
- //! A simple structure to throw as an error
+ /** A simple structure to throw as an error. */
struct error {
error(const std::string& msg) : message(msg) {}
std::string message;
};
- //! Initiate the mailer object
+ /** Initiate the mailer object. */
void init_mailer(config* c);
- //! Create a random string of digits for password encryption
+ /** Create a random string of digits for password encryption. */
std::string create_salt(int length =8);
- //! Create custom salt, if not neaded let it return
- //! and empty string or whatever you feel like
+ /**
+ * Create custom salt.
+ *
+ * If not needed let it return and empty string or whatever you
feel like.
+ */
virtual std::string create_pepper(const std::string& name, int
index) =0;
protected:
- //! Sends an email to the specified address. Requires access to
an SMTP server.
- //! Throws an error if the mail could not be sent.
+ /**
+ * Sends an email to the specified address. Requires access to
an SMTP server.
+ *
+ * Throws an error if the mail could not be sent.
+ */
bool send_mail(const std::string& to_user, const std::string&
subject, const std::string& message);
- //! Used in send_mail()
- //! Should return an empty string when not used
+ /**
+ * Used in send_mail().
+ *
+ * Should return an empty string when not used.
+ */
virtual std::string get_mail(const std::string& user) =0;
mailer* mailer_;
_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits
