Dox updates

qgis · Jul 18, 2017 · 4e0e038 · 4e0e038
1 parent 7f06667
commit 4e0e038
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 1 deletion.
diff --git a/python/core/layout/qgslayoutitemshape.sip b/python/core/layout/qgslayoutitemshape.sip
@@ -64,6 +64,9 @@ class QgsLayoutItemRectangularShape : QgsLayoutItemShape
 
     static QgsLayoutItemRectangularShape *create( QgsLayout *layout, const QVariantMap &settings ) /Factory/;
 %Docstring
+ Returns a new rectangular item for the specified ``layout``.
+
+ The caller takes responsibility for deleting the returned object.
  :rtype: QgsLayoutItemRectangularShape
 %End
 
@@ -107,6 +110,9 @@ class QgsLayoutItemEllipseShape : QgsLayoutItemShape
 
     static QgsLayoutItemEllipseShape *create( QgsLayout *layout, const QVariantMap &settings ) /Factory/;
 %Docstring
+ Returns a new ellipse item for the specified ``layout``.
+
+ The caller takes responsibility for deleting the returned object.
  :rtype: QgsLayoutItemEllipseShape
 %End
 
@@ -137,6 +143,9 @@ class QgsLayoutItemTriangleShape : QgsLayoutItemShape
 
     static QgsLayoutItemTriangleShape *create( QgsLayout *layout, const QVariantMap &settings ) /Factory/;
 %Docstring
+ Returns a new triangle item for the specified ``layout``.
+
+ The caller takes responsibility for deleting the returned object.
  :rtype: QgsLayoutItemTriangleShape
 %End
 

diff --git a/src/core/layout/qgslayoutcontext.h b/src/core/layout/qgslayoutcontext.h
@@ -26,7 +26,7 @@ class QgsFeature;
 class QgsVectorLayer;
 
 /**
- * \ingroup Layout
+ * \ingroup core
  * \class QgsLayoutContext
  * \brief Stores information relating to the current context and rendering settings for a layout.
  * \since QGIS 3.0

diff --git a/src/core/layout/qgslayoutitemshape.h b/src/core/layout/qgslayoutitemshape.h
@@ -79,6 +79,11 @@ class CORE_EXPORT QgsLayoutItemRectangularShape : public QgsLayoutItemShape
     explicit QgsLayoutItemRectangularShape( QgsLayout *layout );
     virtual int type() const override { return QgsLayoutItemRegistry::LayoutRectangle; }
 
+    /**
+     * Returns a new rectangular item for the specified \a layout.
+     *
+     * The caller takes responsibility for deleting the returned object.
+     */
     static QgsLayoutItemRectangularShape *create( QgsLayout *layout, const QVariantMap &settings ) SIP_FACTORY;
 
     /**
@@ -120,6 +125,11 @@ class CORE_EXPORT QgsLayoutItemEllipseShape : public QgsLayoutItemShape
     explicit QgsLayoutItemEllipseShape( QgsLayout *layout );
     virtual int type() const override { return QgsLayoutItemRegistry::LayoutEllipse; }
 
+    /**
+     * Returns a new ellipse item for the specified \a layout.
+     *
+     * The caller takes responsibility for deleting the returned object.
+     */
     static QgsLayoutItemEllipseShape *create( QgsLayout *layout, const QVariantMap &settings ) SIP_FACTORY;
 
   protected:
@@ -147,6 +157,11 @@ class CORE_EXPORT QgsLayoutItemTriangleShape : public QgsLayoutItemShape
     explicit QgsLayoutItemTriangleShape( QgsLayout *layout );
     virtual int type() const override { return QgsLayoutItemRegistry::LayoutTriangle; }
 
+    /**
+     * Returns a new triangle item for the specified \a layout.
+     *
+     * The caller takes responsibility for deleting the returned object.
+     */
     static QgsLayoutItemTriangleShape *create( QgsLayout *layout, const QVariantMap &settings ) SIP_FACTORY;
 
   protected: