Skip to content

Commit 6dfffc5

Browse files
committed
Add missing docs
1 parent bc67c08 commit 6dfffc5

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

python/core/qgsdataitem.sip

+8-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ class QgsDataItem : QObject
5959
Directory,
6060
Layer,
6161
Error,
62-
Favourites
62+
Favourites,
63+
Project //! Represents a QGIS project
6364
};
6465

6566
/** Create new data item. */
@@ -339,6 +340,12 @@ class QgsProjectItem : QgsDataItem
339340
%End
340341
public:
341342

343+
/**
344+
* @brief A data item holding a reference to a QGIS project file.
345+
* @param parent The parent data item.
346+
* @param name The name of the of the project. Displayed to the user.
347+
* @param path The full path to the project.
348+
*/
342349
QgsProjectItem( QgsDataItem* parent, const QString& name, const QString& path );
343350
~QgsProjectItem();
344351

src/core/qgsdataitem.h

+7-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ class CORE_EXPORT QgsDataItem : public QObject
8585
Layer,
8686
Error,
8787
Favourites,
88-
Project
88+
Project //! Represents a QGIS project
8989
};
9090

9191
/** Create new data item. */
@@ -434,6 +434,12 @@ class CORE_EXPORT QgsProjectItem : public QgsDataItem
434434
Q_OBJECT
435435
public:
436436

437+
/**
438+
* @brief A data item holding a reference to a QGIS project file.
439+
* @param parent The parent data item.
440+
* @param name The name of the of the project. Displayed to the user.
441+
* @param path The full path to the project.
442+
*/
437443
QgsProjectItem( QgsDataItem* parent, const QString& name, const QString& path );
438444
~QgsProjectItem();
439445

0 commit comments

Comments
 (0)