From 08bb0269afae5ad4a23fc5677cdda6554342da5c Mon Sep 17 00:00:00 2001
From: clem <clem>
Date: Thu, 07 Oct 2004 00:12:55 +0000
Subject: improved class comment

---
(limited to 'libopie2/opiesecurity/multiauthpassword.cpp')

diff --git a/libopie2/opiesecurity/multiauthpassword.cpp b/libopie2/opiesecurity/multiauthpassword.cpp
index b793717..42341f7 100644
--- a/libopie2/opiesecurity/multiauthpassword.cpp
+++ b/libopie2/opiesecurity/multiauthpassword.cpp
@@ -74,12 +74,11 @@ bool MultiauthPassword::needToAuthenticate(bool at_poweron)
  * \brief Require user authentication to unlock and continue
  *
  * This method will check if you require authentication
- * and then will lock the screen and require a succesfull
- * authentication.
- * Authenticate may enter the event loop and only returns
- * if the user sucesfully authenticated to the system.
- *
- * @return only if succesfully authenticated
+ * and then will lock the screen and ask for a successful
+ * authentication (explaining what it does or not, depending
+ * on your local configuration).
+ * It may go into an event loop, but anyhow it will only end
+ * when the user has successfully authenticated to the system.
  */
 void MultiauthPassword::authenticate(bool at_poweron)
 {
--
cgit v0.9.0.2