fix docs

qgis · Apr 8, 2021 · 99f2367 · 99f2367
1 parent acd3007
commit 99f2367
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/src/core/pointcloud/qgspointcloudblockhandle.h b/src/core/pointcloud/qgspointcloudblockhandle.h
@@ -23,9 +23,12 @@ class CORE_EXPORT QgsPointCloudBlockHandle : public QObject
 {
     Q_OBJECT
   public:
+    //! Constructor
     QgsPointCloudBlockHandle( const QString &dataType, const QgsPointCloudAttributeCollection &attributes, const QgsPointCloudAttributeCollection &requestedAttributes, QgsTileDownloadManagerReply *tileDownloadManagerReply );
   signals:
+    //! Emitted when the block is loaded successfully
     void blockLoadingSucceeded( QgsPointCloudBlock *block );
+    //! Emitted when the block loading has failed
     void blockLoadingFailed( const QString &errorStr );
   private:
     QString mDataType;

diff --git a/src/core/pointcloud/qgspointcloudindex.h b/src/core/pointcloud/qgspointcloudindex.h
@@ -177,11 +177,17 @@ class CORE_EXPORT QgsPointCloudIndex: public QObject
      */
     virtual AccessType accessType() const = 0;
 
+    //! Returns the coordinate reference system of the point cloud index
     virtual QgsCoordinateReferenceSystem crs() const = 0;
+    //! Returns the number of points in the point cloud
     virtual int pointCount() const = 0;
+    //! Returns the statistic \a statistic of \a attribute
     virtual QVariant metadataStatistic( const QString &attribute, QgsStatisticalSummary::Statistic statistic ) const = 0;
+    //! Returns the classes of \a attribute
     virtual QVariantList metadataClasses( const QString &attribute ) const = 0;
+    //! Returns the statistic \a statistic of the class \a value of the attribute \a attribute
     virtual QVariant metadataClassStatistic( const QString &attribute, const QVariant &value, QgsStatisticalSummary::Statistic statistic ) const = 0;
+    //! Returns the original metadata map
     virtual QVariantMap originalMetadata() const = 0;
 
     //! Returns root node of the index

diff --git a/src/core/qgsprovidermetadata.h b/src/core/qgsprovidermetadata.h
@@ -386,6 +386,10 @@ class CORE_EXPORT QgsProviderMetadata : public QObject
       const QgsCoordinateReferenceSystem &crs,
       const QStringList &createOptions = QStringList() ) SIP_FACTORY;
 
+    /**
+     * Creates a new instance of EPT point cloud data provider
+     * \since QGIS 3.20
+     */
     SIP_SKIP virtual QgsEptProvider *createEptDataProvider( const QString &uri, const QString &dataSourceType, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags = QgsDataProvider::ReadFlags() ) SIP_FACTORY;
 
     /**

diff --git a/src/core/qgsproviderregistry.h b/src/core/qgsproviderregistry.h
@@ -179,6 +179,10 @@ class CORE_EXPORT QgsProviderRegistry
       const QgsCoordinateReferenceSystem &crs,
       const QStringList &createOptions = QStringList() ) SIP_FACTORY;
 
+    /**
+     * Creates new instance of EPT point cloud data provider
+     * \since QGIS 3.10
+     */
     SIP_SKIP QgsEptProvider *createEptDataProvider( const QString &providerKey, const QString &uri, const QString &dataSourceType, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags = QgsDataProvider::ReadFlags() ) SIP_FACTORY;
 
     /**