accesssec_plat/eap_qt_configuration_api/inc/eapqtexpandedeaptype.h
changeset 34 ad1f037f1ac2
parent 27 9660a5eb236f
--- a/accesssec_plat/eap_qt_configuration_api/inc/eapqtexpandedeaptype.h	Thu Jun 10 16:12:28 2010 +0300
+++ b/accesssec_plat/eap_qt_configuration_api/inc/eapqtexpandedeaptype.h	Thu Jun 24 11:23:08 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".
  *
@@ -17,22 +17,34 @@
  */
 
 /*
- * %version: 2 %
+ * %version: 5 %
  */
 
 #ifndef EAPQTEXPANDEDEAPTYPE_H
 #define EAPQTEXPANDEDEAPTYPE_H
 
+// System includes
 #include <QByteArray>
 #include <QMetaType>
-#include <eapqtconfigdefs.h>
+#include <eapqtconfigexport.h>
 
+// User includes
 
+// Forward declarations
 class EapQtExpandedEapTypePrivate;
 
+// External data types
+
+// Constants
+
+// Class declaration
 class EAP_QT_PLUGIN_INFO_EXPORT EapQtExpandedEapType
 {
+
 public:
+
+    // Data types
+
     enum Type
     {
         TypeUndefined = 0,
@@ -48,28 +60,47 @@
         TypeProtectedSetup,
         TypePap,
         TypePlainMschapv2,
-        // keep this as the last one
+        // marker for the last item
         TypeLast
     };
 
+    // default constructor
     EapQtExpandedEapType();
+
+    // constructs an instance from an EapQtExpandedEapType::Type value
     EapQtExpandedEapType(const Type type);
-    EapQtExpandedEapType(const QByteArray data);
-    EapQtExpandedEapType(const EapQtExpandedEapType& type);
+
+    // constructs an instance from expanded EAP type binary data,
+    // see RFC3748
+    EapQtExpandedEapType(const QByteArray &data);
+
+    // copy constructor
+    EapQtExpandedEapType(const EapQtExpandedEapType &type);
+
+    // destructor
     ~EapQtExpandedEapType();
 
+    // returns expanded EAP type binary data,
+    // see RFC3748
     QByteArray eapExpandedData() const;
+
+    // returns EapQtExpandedEapType::Type of the instance
     Type type() const;
 
+    // assignment
     EapQtExpandedEapType &operator=(const EapQtExpandedEapType &type);
+
+    // comparisons
     bool operator ==(const EapQtExpandedEapType &right_type_value) const;
     bool operator !=(const EapQtExpandedEapType &right_type_value) const;
 
-private:
+private: // data
+
     QScopedPointer<EapQtExpandedEapTypePrivate> d_ptr;
+
 };
 
 // Make the class known to QMetaType to support using QVariant
 Q_DECLARE_METATYPE(EapQtExpandedEapType)
 
-#endif /* EAPQTEXTENDEDEAPTYPE_H */
+#endif // EAPQTEXTENDEDEAPTYPE_H