qtecomplugins/xqplugins/src/xqplugininfo.cpp
changeset 5 453da2cfceef
parent 1 2b40d63a9c3d
--- a/qtecomplugins/xqplugins/src/xqplugininfo.cpp	Mon May 03 13:18:40 2010 +0300
+++ b/qtecomplugins/xqplugins/src/xqplugininfo.cpp	Fri May 14 16:41:33 2010 +0300
@@ -15,25 +15,35 @@
 * along with this program.  If not, 
 * see "http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html/".
 *
-* Description:  Class implement plugin description
+* Description: This class implements a plugin's description (metadata).
 *
 */
 
 #include "xqplugininfo.h"
 #include "xqplugininfoprivate.h"
 
+
+/*!
+  Constructs plugin info object. 
+*/
 XQPluginInfo::XQPluginInfo()
 :
 d_ptr(new XQPluginInfoPrivate())
 {
 }
 
+/*!
+  Constructs copy of plugin info object.
+*/
 XQPluginInfo::XQPluginInfo(const XQPluginInfo &pluginInfo)
 :
 d_ptr(new XQPluginInfoPrivate(*pluginInfo.d_ptr))
 {
 }
 
+/*!
+  Constructs plugin info object with given data. 
+*/
 XQPluginInfo::XQPluginInfo(quint32 id, 
                            quint32 version, 
                            const QString &dllName, 
@@ -43,6 +53,9 @@
 {
 }
 
+/*!
+  Assignment operator.
+*/
 XQPluginInfo &XQPluginInfo::operator=(const XQPluginInfo &other)
 {
     if (this != &other) {
@@ -54,6 +67,9 @@
     return *this;
 }
 
+/*!
+  Destroys plugin info object.
+*/
 XQPluginInfo::~XQPluginInfo()
 {
     if (d_ptr != 0){
@@ -61,21 +77,33 @@
     }
 }
 
+/*!
+  Returns plugin implementation UID.
+*/
 quint32 XQPluginInfo::uid() const
 {
     return d_ptr->uid();
 }
 
+/*!
+  Returns plugin implementation version.
+*/
 quint32 XQPluginInfo::version() const
 {
     return d_ptr->version();
 }
 
+/*!
+  Returns plugin dll name.
+*/
 const QString& XQPluginInfo::dllName() const
 {
     return d_ptr->dllName();
 }
 
+/*!
+  Returns plugin implementation opaque data. This is given by SERVICE.CONFIGURATION variable in pro file of the plugin.
+*/
 const QString& XQPluginInfo::opaqueData() const
 {
     return d_ptr->opaqueData();