Fix dox

qgis · Jan 11, 2021 · 4d3a022 · 4d3a022
1 parent ad94415
commit 4d3a022
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/gui/layout/qgslayoutitemguiregistry.h b/src/gui/layout/qgslayoutitemguiregistry.h
@@ -275,6 +275,18 @@ class GUI_EXPORT QgsLayoutItemGuiMetadata : public QgsLayoutItemAbstractGuiMetad
 
     QgsLayoutItem *createItem( QgsLayout *layout ) override;
     void newItemAddedToLayout( QgsLayoutItem *item ) override;
+
+    /**
+     * Called when a newly created item of the associated type has been added to a layout.
+     *
+     * This is only called for additions which result from GUI operations - i.e. it is not
+     * called for items added from templates.
+     *
+     * The \a properties map will be filled with any custom properties which were specified during
+     * the item creation.
+     *
+     * \since QGIS 3.18
+     */
     void newItemAddedToLayout( QgsLayoutItem *item, const QVariantMap &properties );
 
   protected: