Dox

qgis · Aug 5, 2020 · ea392ea · ea392ea
1 parent f2d172f
commit ea392ea
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 0 deletions.
diff --git a/python/core/auto_generated/annotations/qgsannotationlinestringitem.sip.in b/python/core/auto_generated/annotations/qgsannotationlinestringitem.sip.in
@@ -35,7 +35,12 @@ Constructor for QgsAnnotationLineStringItem, with the specified ``linestring`` i
 
     virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
 
+
     static QgsAnnotationLineStringItem *create() /Factory/;
+%Docstring
+Creates a new linestring annotation item.
+%End
+
     virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
 
     virtual QgsRectangle boundingBox() const;

diff --git a/python/core/auto_generated/annotations/qgsannotationmarkeritem.sip.in b/python/core/auto_generated/annotations/qgsannotationmarkeritem.sip.in
@@ -35,7 +35,12 @@ Constructor for QgsAnnotationMarkerItem, at the specified ``point`` in the given
 
     virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
 
+
     static QgsAnnotationMarkerItem *create() /Factory/;
+%Docstring
+Creates a new marker annotation item.
+%End
+
     virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
 
     virtual QgsAnnotationMarkerItem *clone() /Factory/;

diff --git a/python/core/auto_generated/annotations/qgsannotationpolygonitem.sip.in b/python/core/auto_generated/annotations/qgsannotationpolygonitem.sip.in
@@ -35,7 +35,12 @@ Constructor for QgsAnnotationPolygonItem, with the specified ``polygon`` in the
 
     virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
 
+
     static QgsAnnotationPolygonItem *create() /Factory/;
+%Docstring
+Creates a new polygon annotation item.
+%End
+
     virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
 
     virtual QgsAnnotationPolygonItem *clone() /Factory/;

diff --git a/src/core/annotations/qgsannotationlinestringitem.h b/src/core/annotations/qgsannotationlinestringitem.h
@@ -42,7 +42,12 @@ class CORE_EXPORT QgsAnnotationLineStringItem : public QgsAnnotationItem
     QString type() const override;
     void render( QgsRenderContext &context, QgsFeedback *feedback ) override;
     bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
+
+    /**
+     * Creates a new linestring annotation item.
+     */
     static QgsAnnotationLineStringItem *create() SIP_FACTORY;
+
     bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
     QgsRectangle boundingBox() const override;
 

diff --git a/src/core/annotations/qgsannotationmarkeritem.h b/src/core/annotations/qgsannotationmarkeritem.h
@@ -42,7 +42,12 @@ class CORE_EXPORT QgsAnnotationMarkerItem : public QgsAnnotationItem
     QString type() const override;
     void render( QgsRenderContext &context, QgsFeedback *feedback ) override;
     bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
+
+    /**
+     * Creates a new marker annotation item.
+     */
     static QgsAnnotationMarkerItem *create() SIP_FACTORY;
+
     bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
     QgsAnnotationMarkerItem *clone() override SIP_FACTORY;
     QgsRectangle boundingBox() const override;

diff --git a/src/core/annotations/qgsannotationpolygonitem.h b/src/core/annotations/qgsannotationpolygonitem.h
@@ -42,7 +42,12 @@ class CORE_EXPORT QgsAnnotationPolygonItem : public QgsAnnotationItem
     QString type() const override;
     void render( QgsRenderContext &context, QgsFeedback *feedback ) override;
     bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
+
+    /**
+     * Creates a new polygon annotation item.
+     */
     static QgsAnnotationPolygonItem *create() SIP_FACTORY;
+
     bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
     QgsAnnotationPolygonItem *clone() override SIP_FACTORY;
     QgsRectangle boundingBox() const override;