add missing doxymentation to gui/layout

qgis · Oct 24, 2018 · fa92f41 · fa92f41
1 parent 3663de9
commit fa92f41
Show file tree

Hide file tree

Showing 14 changed files with 38 additions and 12 deletions.
diff --git a/python/gui/auto_generated/layout/qgslayoutdesignerinterface.sip.in b/python/gui/auto_generated/layout/qgslayoutdesignerinterface.sip.in
@@ -91,7 +91,7 @@ Selects the specified ``items``.
 %Docstring
 Toggles whether the atlas preview mode should be ``enabled`` in the designer.
 
-.. seealso:: :py:func:`atlasPreviewModeEnabled`
+.. seealso:: :py:func:`atlasPreviewEnabled`
 
 .. versionadded:: 3.4
 %End

diff --git a/python/gui/auto_generated/layout/qgslayoutitemguiregistry.sip.in b/python/gui/auto_generated/layout/qgslayoutitemguiregistry.sip.in
@@ -178,8 +178,6 @@ Creates a new empty item GUI registry.
 
 QgsLayoutItemGuiRegistry is not usually directly created, but rather accessed through
 :py:func:`QgsGui.layoutItemGuiRegistry()`
-
-.. seealso:: :py:func:`populate`
 %End
 
     ~QgsLayoutItemGuiRegistry();

diff --git a/python/gui/auto_generated/layout/qgslayoutitemwidget.sip.in b/python/gui/auto_generated/layout/qgslayoutitemwidget.sip.in
@@ -150,15 +150,31 @@ This widget can be embedded into other layout item widgets.
 #include "qgslayoutitemwidget.h"
 %End
   public:
+
     QgsLayoutItemPropertiesWidget( QWidget *parent, QgsLayoutItem *item );
+%Docstring
+Constructs a QgsLayoutItemPropertiesWidget with a ``parent`` and for the given layout ``item``.
+%End
 
     QgsLayoutItem::ReferencePoint positionMode() const;
+%Docstring
+Returns the position mode
+%End
 
     void showBackgroundGroup( bool showGroup );
+%Docstring
+Determines if the background of the group box shall be shown
+%End
 
     void showFrameGroup( bool showGroup );
+%Docstring
+Determines if the frame of the group box shall be shown
+%End
 
     void setItem( QgsLayoutItem *item );
+%Docstring
+Sets the layout item
+%End
 
   protected slots:
     void initializeDataDefinedButtons();

diff --git a/python/gui/auto_generated/layout/qgslayoutviewmouseevent.sip.in b/python/gui/auto_generated/layout/qgslayoutviewmouseevent.sip.in
@@ -55,8 +55,6 @@ The ``ignoreItems`` argument can be used to specify a list of items to avoid sna
     QPointF layoutPoint() const;
 %Docstring
 Returns the event point location in layout coordinates.
-
-.. seealso:: :py:func:`pos`
 %End
 
     QPointF snappedPoint() const;
@@ -65,8 +63,6 @@ Returns the snapped event point location in layout coordinates. The snapped poin
 all possible snapping methods, such as snapping to grid or guide lines.
 
 .. seealso:: :py:func:`isSnapped`
-
-.. seealso:: :py:func:`pos`
 %End
 
     bool isSnapped() const;

diff --git a/python/gui/auto_generated/layout/qgslayoutviewtooladditem.sip.in b/python/gui/auto_generated/layout/qgslayoutviewtooladditem.sip.in
@@ -22,6 +22,9 @@ Layout view tool for adding items to a layout.
   public:
 
     QgsLayoutViewToolAddItem( QgsLayoutView *view /TransferThis/ );
+%Docstring
+Constructs a QgsLayoutViewToolAddItem for the given layout ``view``.
+%End
 
     int itemMetadataId() const;
 %Docstring

diff --git a/python/gui/auto_generated/layout/qgslayoutviewtooladdnodeitem.sip.in b/python/gui/auto_generated/layout/qgslayoutviewtooladdnodeitem.sip.in
@@ -22,6 +22,9 @@ Layout view tool for adding node based items to a layout.
   public:
 
     QgsLayoutViewToolAddNodeItem( QgsLayoutView *view /TransferThis/ );
+%Docstring
+Constructs a QgsLayoutViewToolAddNodeItem for the given layout ``view``.
+%End
 
     int itemMetadataId() const;
 %Docstring

diff --git a/python/gui/auto_generated/layout/qgslayoutviewtoolselect.sip.in b/python/gui/auto_generated/layout/qgslayoutviewtoolselect.sip.in
@@ -44,6 +44,9 @@ Constructor for QgsLayoutViewToolSelect.
 
 
     void setLayout( QgsLayout *layout );
+%Docstring
+Sets the a ``layout``.
+%End
 
 };
 

diff --git a/src/gui/layout/qgslayoutdesignerinterface.h b/src/gui/layout/qgslayoutdesignerinterface.h
@@ -111,7 +111,7 @@ class GUI_EXPORT QgsLayoutDesignerInterface: public QObject
     /**
      * Toggles whether the atlas preview mode should be \a enabled in the designer.
      *
-     * \see atlasPreviewModeEnabled()
+     * \see atlasPreviewEnabled()
      * \since QGIS 3.4
      */
     virtual void setAtlasPreviewEnabled( bool enabled ) = 0;

diff --git a/src/gui/layout/qgslayoutitemguiregistry.h b/src/gui/layout/qgslayoutitemguiregistry.h
@@ -339,8 +339,6 @@ class GUI_EXPORT QgsLayoutItemGuiRegistry : public QObject
      *
      * QgsLayoutItemGuiRegistry is not usually directly created, but rather accessed through
      * QgsGui::layoutItemGuiRegistry().
-     *
-     * \see populate()
     */
     QgsLayoutItemGuiRegistry( QObject *parent = nullptr );
 

diff --git a/src/gui/layout/qgslayoutitemwidget.h b/src/gui/layout/qgslayoutitemwidget.h
@@ -193,14 +193,22 @@ class GUI_EXPORT QgsLayoutItemPropertiesWidget: public QWidget, private Ui::QgsL
 {
     Q_OBJECT
   public:
+
+    /**
+     * Constructs a QgsLayoutItemPropertiesWidget with a \a parent and for the given layout \a item.
+     */
     QgsLayoutItemPropertiesWidget( QWidget *parent, QgsLayoutItem *item );
 
+    //! Returns the position mode
     QgsLayoutItem::ReferencePoint positionMode() const;
 
+    //! Determines if the background of the group box shall be shown
     void showBackgroundGroup( bool showGroup );
 
+    //! Determines if the frame of the group box shall be shown
     void showFrameGroup( bool showGroup );
 
+    //! Sets the layout item
     void setItem( QgsLayoutItem *item );
 
   protected slots:

diff --git a/src/gui/layout/qgslayoutviewmouseevent.h b/src/gui/layout/qgslayoutviewmouseevent.h
@@ -67,15 +67,13 @@ class GUI_EXPORT QgsLayoutViewMouseEvent : public QMouseEvent
 
     /**
      * Returns the event point location in layout coordinates.
-     * \see pos()
      */
     QPointF layoutPoint() const;
 
     /**
      * Returns the snapped event point location in layout coordinates. The snapped point will consider
      * all possible snapping methods, such as snapping to grid or guide lines.
      * \see isSnapped()
-     * \see pos()
      */
     QPointF snappedPoint() const { return mSnappedPoint; }
 

diff --git a/src/gui/layout/qgslayoutviewtooladditem.h b/src/gui/layout/qgslayoutviewtooladditem.h
@@ -34,6 +34,7 @@ class GUI_EXPORT QgsLayoutViewToolAddItem : public QgsLayoutViewTool
 
   public:
 
+    //! Constructs a QgsLayoutViewToolAddItem for the given layout \a view.
     QgsLayoutViewToolAddItem( QgsLayoutView *view SIP_TRANSFERTHIS );
 
     /**

diff --git a/src/gui/layout/qgslayoutviewtooladdnodeitem.h b/src/gui/layout/qgslayoutviewtooladdnodeitem.h
@@ -34,6 +34,7 @@ class GUI_EXPORT QgsLayoutViewToolAddNodeItem : public QgsLayoutViewTool
 
   public:
 
+    //! Constructs a QgsLayoutViewToolAddNodeItem for the given layout \a view.
     QgsLayoutViewToolAddNodeItem( QgsLayoutView *view SIP_TRANSFERTHIS );
 
     /**

diff --git a/src/gui/layout/qgslayoutviewtoolselect.h b/src/gui/layout/qgslayoutviewtoolselect.h
@@ -58,6 +58,7 @@ class GUI_EXPORT QgsLayoutViewToolSelect : public QgsLayoutViewTool
     SIP_SKIP QgsLayoutMouseHandles *mouseHandles();
     ///@endcond
 
+    //! Sets the a \a layout.
     void setLayout( QgsLayout *layout );
 
   private: