accesssec_plat/eap_qt_configuration_api/inc/eapqtplugininfo.h
changeset 39 fe6b6762fccd
parent 33 938269283a16
--- a/accesssec_plat/eap_qt_configuration_api/inc/eapqtplugininfo.h	Wed Jun 23 18:14:55 2010 +0300
+++ b/accesssec_plat/eap_qt_configuration_api/inc/eapqtplugininfo.h	Tue Jul 06 14:18:35 2010 +0300
@@ -2,7 +2,7 @@
  * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
  * All rights reserved.
  * This component and the accompanying materials are made available
- * under the terms of the License "Eclipse Public License v1.0"
+ * under the terms of "Eclipse Public License v1.0"
  * which accompanies this distribution, and is available
  * at the URL "http://www.eclipse.org/legal/epl-v10.html".
  *
@@ -12,40 +12,70 @@
  * Contributors:
  *
  * Description: 
- *   Control Panel EAP plugin information
+ *   EAP UI plugin information
  *
  */
 
 /*
- * %version: 2 %
+ * %version: 5 %
  */
 
 #ifndef EAPQTPLUGININFO_H
 #define EAPQTPLUGININFO_H
 
+// System includes
 #include <QString>
-#include <eapqtconfigdefs.h>
+#include <eapqtconfigexport.h>
 
+// User includes
+
+// Forward declarations
 class EapQtPluginHandle;
 class EapQtPluginInfoPrivate;
 
+// External data types
+
+// Constants
+
+// Class declaration
 class EAP_QT_PLUGIN_INFO_EXPORT EapQtPluginInfo
 {
+
 public:
-    EapQtPluginInfo(const EapQtPluginInfo & info);
-    EapQtPluginInfo(EapQtPluginHandle id, QString locId, int orderNumber );
+
+    // Data types
+
+    // copy constructor
+    EapQtPluginInfo(const EapQtPluginInfo &info);
+
+    // constructs an instance from an plugin handle,
+    // plugin name as a string (e.g. "EAP-SIM") used on the UI, and oder number;
+    // order number specifies the location of the plugin in lists of
+    // EAP plugins shown on the UI
+    EapQtPluginInfo(const EapQtPluginHandle &id, const QString &locId, const int orderNumber );
+
+    // destructor
     ~EapQtPluginInfo();
 
+    // returns plugin handle of the instance
     EapQtPluginHandle pluginHandle() const;
+
+    // returns plugin name string of the instance
     QString localizationId() const;
+
+    // returns order number of the instance
     int orderNumber() const;
 
+    // assignment
     EapQtPluginInfo &operator=(const EapQtPluginInfo &info);
     
 private:
     EapQtPluginInfo();
 
+private: // data
+
     QScopedPointer<EapQtPluginInfoPrivate> d_ptr;
+
 };
 
-#endif
+#endif // EAPQTPLUGININFO_H