Add missing docs

qgis · Dec 11, 2015 · 6dfffc5 · 6dfffc5
1 parent bc67c08
commit 6dfffc5
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/python/core/qgsdataitem.sip b/python/core/qgsdataitem.sip
@@ -59,7 +59,8 @@ class QgsDataItem : QObject
       Directory,
       Layer,
       Error,
-      Favourites
+      Favourites,
+      Project //! Represents a QGIS project
     };
 
     /** Create new data item. */
@@ -339,6 +340,12 @@ class QgsProjectItem : QgsDataItem
 %End
   public:
 
+    /**
+     * @brief A data item holding a reference to a QGIS project file.
+     * @param parent The parent data item.
+     * @param name The name of the of the project. Displayed to the user.
+     * @param path The full path to the project.
+     */
     QgsProjectItem( QgsDataItem* parent, const QString& name, const QString& path );
     ~QgsProjectItem();
 

diff --git a/src/core/qgsdataitem.h b/src/core/qgsdataitem.h
@@ -85,7 +85,7 @@ class CORE_EXPORT QgsDataItem : public QObject
       Layer,
       Error,
       Favourites,
-      Project
+      Project //! Represents a QGIS project
     };
 
     /** Create new data item. */
@@ -434,6 +434,12 @@ class CORE_EXPORT QgsProjectItem : public QgsDataItem
     Q_OBJECT
   public:
 
+    /**
+     * @brief A data item holding a reference to a QGIS project file.
+     * @param parent The parent data item.
+     * @param name The name of the of the project. Displayed to the user.
+     * @param path The full path to the project.
+     */
     QgsProjectItem( QgsDataItem* parent, const QString& name, const QString& path );
     ~QgsProjectItem();