Add documentation for STAC browser data items

This commit is contained in:
Mathieu Pellerin 2025-06-12 18:01:25 +07:00
parent dadf550c40
commit 5acc0b6d83

View File

@ -28,7 +28,11 @@ class QgsStacController;
class QgsStacCollection; class QgsStacCollection;
//! Item to display that there are additional STAC items which are not loaded. /**
* \ingroup core
* \brief Item to display that there are additional STAC items which are not loaded.
* \since QGIS 3.44
*/
class CORE_EXPORT QgsStacFetchMoreItem : public QgsDataItem class CORE_EXPORT QgsStacFetchMoreItem : public QgsDataItem
{ {
Q_OBJECT Q_OBJECT
@ -40,7 +44,11 @@ class CORE_EXPORT QgsStacFetchMoreItem : public QgsDataItem
}; };
//! Item for STAC Items within a catalog or collection. /**
* \ingroup core
* \brief Item for STAC Items within a catalog or collection.
* \since QGIS 3.44
*/
class CORE_EXPORT QgsStacItemItem : public QgsDataItem class CORE_EXPORT QgsStacItemItem : public QgsDataItem
{ {
Q_OBJECT Q_OBJECT
@ -79,7 +87,11 @@ class CORE_EXPORT QgsStacItemItem : public QgsDataItem
QString mConnName; QString mConnName;
}; };
//! Item for catalogs and collections. /**
* \ingroup core
* \brief Item for catalogs and collections.
* \since QGIS 3.44
*/
class CORE_EXPORT QgsStacCatalogItem : public QgsDataCollectionItem class CORE_EXPORT QgsStacCatalogItem : public QgsDataCollectionItem
{ {
Q_OBJECT Q_OBJECT
@ -132,7 +144,11 @@ class CORE_EXPORT QgsStacCatalogItem : public QgsDataCollectionItem
QUrl mFetchMoreUrl; QUrl mFetchMoreUrl;
}; };
//! Item for STAC connections, is also a catalog itself. /**
* \ingroup core
* \brief Item for STAC connections, is also a catalog itself.
* \since QGIS 3.44
*/
class CORE_EXPORT QgsStacConnectionItem : public QgsStacCatalogItem class CORE_EXPORT QgsStacConnectionItem : public QgsStacCatalogItem
{ {
Q_OBJECT Q_OBJECT
@ -148,7 +164,11 @@ class CORE_EXPORT QgsStacConnectionItem : public QgsStacCatalogItem
std::unique_ptr<QgsStacController> mController; std::unique_ptr<QgsStacController> mController;
}; };
//! Root item for STAC connections. /**
* \ingroup core
* \brief Root item for STAC connections.
* \since QGIS 3.44
*/
class CORE_EXPORT QgsStacRootItem : public QgsConnectionsRootItem class CORE_EXPORT QgsStacRootItem : public QgsConnectionsRootItem
{ {
Q_OBJECT Q_OBJECT
@ -163,7 +183,11 @@ class CORE_EXPORT QgsStacRootItem : public QgsConnectionsRootItem
void onConnectionsChanged(); void onConnectionsChanged();
}; };
//! Provider for STAC root data item. /**
* \ingroup core
* \brief Provider for STAC root data item.
* \since QGIS 3.44
*/
class CORE_EXPORT QgsStacDataItemProvider : public QgsDataItemProvider class CORE_EXPORT QgsStacDataItemProvider : public QgsDataItemProvider
{ {
public: public: