Added documentation for QgsDataItemProviderFromPlugin constructor

qgis · Sep 19, 2017 · a5647c7016f25a120facf0f2a1461092180e242d · a5647c7
1 parent a6b6892
commit a5647c7016f25a120facf0f2a1461092180e242d
Unified Split

Showing with 8 additions and 0 deletions.

+8 −0 src/core/qgsdataitemproviderregistry.cpp
diff --git a/src/core/qgsdataitemproviderregistry.cpp b/src/core/qgsdataitemproviderregistry.cpp
@@ -36,6 +36,14 @@ typedef QList<QgsDataItemProvider *> *dataItemProviders_t();
 class QgsDataItemProviderFromPlugin : public QgsDataItemProvider
 {
   public:
+
+    /**
+     * QgsDataItemProviderFromPlugin constructor
+     * \param name plugin name
+     * \param capabilitiesFunc function pointer to the data capabilities
+     * \param dataItemFunc function pointer to the data items
+     * \param handlesDirectoryPathFunc function pointer to handlesDirectoryPath
+     */
     QgsDataItemProviderFromPlugin( const QString &name, dataCapabilities_t *capabilitiesFunc, dataItem_t *dataItemFunc, handlesDirectoryPath_t *handlesDirectoryPathFunc )
       : mName( name )
       , mCapabilitiesFunc( capabilitiesFunc )