securitysettings/eapqtdialogs/inc/eapfastpacfilepwquerydialog.h
changeset 36 c98682f98478
parent 34 ad1f037f1ac2
--- a/securitysettings/eapqtdialogs/inc/eapfastpacfilepwquerydialog.h	Thu Jun 24 11:23:08 2010 +0300
+++ b/securitysettings/eapqtdialogs/inc/eapfastpacfilepwquerydialog.h	Fri Jul 09 10:14:51 2010 +0300
@@ -11,24 +11,37 @@
 *
 * Contributors:
 *
-* Description: Fast Pac File Password Query Dialog
+* Description: EAP-FAST PAC File Password Query Dialog
 *
 */
 
 /*
-* %version: 3 %
+* %version: 4 %
 */
 
 #ifndef __EAPFASTPACFILEPWQUERYDIALOG_H__
 #define __EAPFASTPACFILEPWQUERYDIALOG_H__
 
-
+// System includes
 #include <HbInputDialog>
 #include <hbdevicedialoginterface.h>
 
+// User includes
 
+// Forward declarations
 class HbTranslator;
 
+// External data types
+
+// Constants
+
+/*!
+   @addtogroup group_eap_fast_pac_file_pwd_query_dialog
+   @{
+ */
+
+// Class declaration
+
 class EapFastPacFilePwQueryDialog: public HbInputDialog, public HbDeviceDialogInterface
     {
     Q_OBJECT
@@ -43,17 +56,18 @@
         void createDialog( const QVariantMap &parameters );
         
         /* Device dialog parameters to be set while dialog is displayed.
-         * Not supported.
+         * Not supported. (from HbDeviceDialogInterface)
          */
         bool setDeviceDialogParameters(const QVariantMap &parameters);
         
-        /* Not supported */
+        /* Not supported. (from HbDeviceDialogInterface */
         int deviceDialogError() const;
         
-        /* Closes the device dialog */
+        /* Closes the device dialog. (from HbDeviceDialogInterface */
         void closeDeviceDialog(bool byClient);
         
-        /* Returns a pointer to this dialog widget */
+        /* Returns a pointer to this dialog widget.
+           (from HbDeviceDialogInterface) */
         HbPopup *deviceDialogWidget() const;
                 
     signals:
@@ -77,20 +91,23 @@
                 
         Q_DISABLE_COPY(EapFastPacFilePwQueryDialog)
    
-    private:
-        /* Pointer to the line edit object */
+    private: // data
+        // NOT OWNED
+        //! Pointer to the line edit object
         HbLineEdit *mEdit;
                                 
-        /* Pointer to the HbTranslator */
+        // OWNED        
+        //! Pointer to the password validator object
         QScopedPointer<HbTranslator> mTranslator;
                 
-        /* Tells whether close has already been called for the dialog */
+        //! Tells whether close has already been called for the dialog
         bool mClose;
         
-        /* Tells whether Ok Action has already been pressed */
+        //! Tells whether Ok Action has already been pressed
         bool mOkActionPressed;
     };
 
+/*! @} */
 
 #endif // __EAPFASTPACFILEPWQUERYDIALOG_H__