summaryrefslogtreecommitdiff
path: root/libopie2
authorclem <clem>2004-10-07 00:12:55 (UTC)
committer clem <clem>2004-10-07 00:12:55 (UTC)
commit08bb0269afae5ad4a23fc5677cdda6554342da5c (patch) (side-by-side diff)
tree21ddd5f576967ef390c555f6fa26a78a28a6e6c3 /libopie2
parentd2256c288998704c0b43986865c884070b983d89 (diff)
downloadopie-08bb0269afae5ad4a23fc5677cdda6554342da5c.zip
opie-08bb0269afae5ad4a23fc5677cdda6554342da5c.tar.gz
opie-08bb0269afae5ad4a23fc5677cdda6554342da5c.tar.bz2
improved class comment
Diffstat (limited to 'libopie2') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiesecurity/multiauthpassword.cpp11
-rw-r--r--libopie2/opiesecurity/multiauthpassword.h4
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
@@ -71,18 +71,17 @@ 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)
{
if ( ! needToAuthenticate(at_poweron) )
return;
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
@@ -36,17 +36,17 @@
#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 );