aboutsummaryrefslogtreecommitdiffstats
path: root/src/messaging/defaultAuthenticator.hpp
diff options
context:
space:
mode:
authorVincent Richard <[email protected]>2004-12-22 14:55:43 +0000
committerVincent Richard <[email protected]>2004-12-22 14:55:43 +0000
commit4f9e439eecbca00b6de0d64e8a3f39b5e7707284 (patch)
treea2631ed6d1a86ac9f81164f1b9305434aed0a362 /src/messaging/defaultAuthenticator.hpp
parentUpdated ChangeLog for new functions in 'component'. (diff)
downloadvmime-4f9e439eecbca00b6de0d64e8a3f39b5e7707284.tar.gz
vmime-4f9e439eecbca00b6de0d64e8a3f39b5e7707284.zip
Some more class documentation.
Diffstat (limited to 'src/messaging/defaultAuthenticator.hpp')
-rw-r--r--src/messaging/defaultAuthenticator.hpp6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/messaging/defaultAuthenticator.hpp b/src/messaging/defaultAuthenticator.hpp
index 9480ec56..dcd0f297 100644
--- a/src/messaging/defaultAuthenticator.hpp
+++ b/src/messaging/defaultAuthenticator.hpp
@@ -29,8 +29,10 @@ namespace vmime {
namespace messaging {
-/** An auhenticator that simply returns the credentials set in the
- * session properties (named 'username' and 'password').
+/** Default implementation for authenticator. It simply returns
+ * the credentials set in the session properties (named 'username'
+ * and 'password'). This is the default implementation used if
+ * you do not write your own authenticator object.
*/
class defaultAuthenticator : public authenticator