| -rw-r--r-- | libopie2/opiesecurity/multiauthpassword.cpp | 11 | ||||
| -rw-r--r-- | libopie2/opiesecurity/multiauthpassword.h | 4 |
2 files changed, 7 insertions, 8 deletions
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 @@ -65,30 +65,29 @@ bool MultiauthPassword::needToAuthenticate(bool at_poweron) return true; else if ( at_poweron && cfg.readBoolEntry("onResume", false) ) return true; else return false; } /** * \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) { if ( ! needToAuthenticate(at_poweron) ) return; /* Constructs the main window, which displays messages and blocks * access to the desktop */ MultiauthMainWindow win; // resize the QDialog object so it fills all the screen diff --git a/libopie2/opiesecurity/multiauthpassword.h b/libopie2/opiesecurity/multiauthpassword.h index f43934d..fe276da 100644 --- a/libopie2/opiesecurity/multiauthpassword.h +++ b/libopie2/opiesecurity/multiauthpassword.h @@ -30,29 +30,29 @@ Boston, MA 02111-1307, USA. */ #ifndef OPIE_SEC_MULTIAUTHPASSWORD_H #define OPIE_SEC_MULTIAUTHPASSWORD_H namespace Opie { namespace Security { /** - * This is the dropin replacement for libqpes Password class. + * This is the dropin replacement for the libqpe Password class. * If you call authenticate() a widget will cover the whole screen * and only return if the user is able to authenticate with any of the * configured Authentication Plugins. - * This uses the \sa Opie::Security::MultiauthMainWindow internally. + * It uses the Opie::Security::MultiauthMainWindow QDialog internally. * * @author Clement Séveillac, Holger Freyther */ class MultiauthPassword { public: static bool needToAuthenticate( bool atpoweron = false ); static void authenticate(bool atpoweron = false); }; } } |