Skip to content

Commit 4e0e038

Browse files
committed
Dox updates
1 parent 7f06667 commit 4e0e038

File tree

3 files changed

+25
-1
lines changed

3 files changed

+25
-1
lines changed

python/core/layout/qgslayoutitemshape.sip

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,9 @@ class QgsLayoutItemRectangularShape : QgsLayoutItemShape
6464

6565
static QgsLayoutItemRectangularShape *create( QgsLayout *layout, const QVariantMap &settings ) /Factory/;
6666
%Docstring
67+
Returns a new rectangular item for the specified ``layout``.
68+
69+
The caller takes responsibility for deleting the returned object.
6770
:rtype: QgsLayoutItemRectangularShape
6871
%End
6972

@@ -107,6 +110,9 @@ class QgsLayoutItemEllipseShape : QgsLayoutItemShape
107110

108111
static QgsLayoutItemEllipseShape *create( QgsLayout *layout, const QVariantMap &settings ) /Factory/;
109112
%Docstring
113+
Returns a new ellipse item for the specified ``layout``.
114+
115+
The caller takes responsibility for deleting the returned object.
110116
:rtype: QgsLayoutItemEllipseShape
111117
%End
112118

@@ -137,6 +143,9 @@ class QgsLayoutItemTriangleShape : QgsLayoutItemShape
137143

138144
static QgsLayoutItemTriangleShape *create( QgsLayout *layout, const QVariantMap &settings ) /Factory/;
139145
%Docstring
146+
Returns a new triangle item for the specified ``layout``.
147+
148+
The caller takes responsibility for deleting the returned object.
140149
:rtype: QgsLayoutItemTriangleShape
141150
%End
142151

src/core/layout/qgslayoutcontext.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class QgsFeature;
2626
class QgsVectorLayer;
2727

2828
/**
29-
* \ingroup Layout
29+
* \ingroup core
3030
* \class QgsLayoutContext
3131
* \brief Stores information relating to the current context and rendering settings for a layout.
3232
* \since QGIS 3.0

src/core/layout/qgslayoutitemshape.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ class CORE_EXPORT QgsLayoutItemRectangularShape : public QgsLayoutItemShape
7979
explicit QgsLayoutItemRectangularShape( QgsLayout *layout );
8080
virtual int type() const override { return QgsLayoutItemRegistry::LayoutRectangle; }
8181

82+
/**
83+
* Returns a new rectangular item for the specified \a layout.
84+
*
85+
* The caller takes responsibility for deleting the returned object.
86+
*/
8287
static QgsLayoutItemRectangularShape *create( QgsLayout *layout, const QVariantMap &settings ) SIP_FACTORY;
8388

8489
/**
@@ -120,6 +125,11 @@ class CORE_EXPORT QgsLayoutItemEllipseShape : public QgsLayoutItemShape
120125
explicit QgsLayoutItemEllipseShape( QgsLayout *layout );
121126
virtual int type() const override { return QgsLayoutItemRegistry::LayoutEllipse; }
122127

128+
/**
129+
* Returns a new ellipse item for the specified \a layout.
130+
*
131+
* The caller takes responsibility for deleting the returned object.
132+
*/
123133
static QgsLayoutItemEllipseShape *create( QgsLayout *layout, const QVariantMap &settings ) SIP_FACTORY;
124134

125135
protected:
@@ -147,6 +157,11 @@ class CORE_EXPORT QgsLayoutItemTriangleShape : public QgsLayoutItemShape
147157
explicit QgsLayoutItemTriangleShape( QgsLayout *layout );
148158
virtual int type() const override { return QgsLayoutItemRegistry::LayoutTriangle; }
149159

160+
/**
161+
* Returns a new triangle item for the specified \a layout.
162+
*
163+
* The caller takes responsibility for deleting the returned object.
164+
*/
150165
static QgsLayoutItemTriangleShape *create( QgsLayout *layout, const QVariantMap &settings ) SIP_FACTORY;
151166

152167
protected:

0 commit comments

Comments
 (0)