Fix Travis warnings and missing docs/sip

qgis · Sep 29, 2016 · ca7b504 · ca7b504
1 parent 3dcc69a
commit ca7b504
Show file tree

Hide file tree

Showing 8 changed files with 70 additions and 0 deletions.
diff --git a/python/core/symbology-ng/qgspointdistancerenderer.sip b/python/core/symbology-ng/qgspointdistancerenderer.sip
@@ -183,6 +183,7 @@ class QgsPointDistanceRenderer : QgsFeatureRenderer
      * @param context destination render context
      * @param labelShifts displacement for individual label positions
      * @param group group of clustered features to label
+     * @note may not be available in Python bindings on some platforms
      */
     void drawLabels( QPointF centerPoint, QgsSymbolRenderContext& context, const QList<QPointF>& labelShifts, const  QgsPointDistanceRenderer::ClusteredGroup& group );
 

diff --git a/python/gui/gui.sip b/python/gui/gui.sip
@@ -234,6 +234,7 @@
 %Include symbology-ng/qgslayerpropertieswidget.sip
 %Include symbology-ng/qgsnullsymbolrendererwidget.sip
 %Include symbology-ng/qgspenstylecombobox.sip
+%Include symbology-ng/qgspointclusterrendererwidget.sip
 %Include symbology-ng/qgspointdisplacementrendererwidget.sip
 %Include symbology-ng/qgsrendererpropertiesdialog.sip
 %Include symbology-ng/qgsrendererwidget.sip

diff --git a/python/gui/symbology-ng/qgspointclusterrendererwidget.sip b/python/gui/symbology-ng/qgspointclusterrendererwidget.sip
@@ -0,0 +1,33 @@
+/** \class QgsPointClusterRendererWidget
+ * \ingroup gui
+ * A widget which allows configuration of the properties for a QgsPointClusterRenderer.
+ * \note added in QGIS 3.0
+ */
+
+class QgsPointClusterRendererWidget: QgsRendererWidget
+{
+%TypeHeaderCode
+#include <qgspointclusterrendererwidget.h>
+%End
+  public:
+
+    /** Returns a new QgsPointClusterRendererWidget.
+     * @param layer associated vector layer
+     * @param style style collection
+     * @param renderer source QgsPointClusterRenderer renderer
+     * @returns new QgsRendererWidget
+     */
+    static QgsRendererWidget* create( QgsVectorLayer* layer, QgsStyle* style, QgsFeatureRenderer* renderer ) /Factory/;
+
+    /** Constructor for QgsPointClusterRendererWidget.
+     * @param layer associated vector layer
+     * @param style style collection
+     * @param renderer source QgsPointClusterRenderer renderer
+     */
+    QgsPointClusterRendererWidget( QgsVectorLayer* layer, QgsStyle* style, QgsFeatureRenderer* renderer );
+
+    ~QgsPointClusterRendererWidget();
+
+    QgsFeatureRenderer* renderer();
+    void setContext( const QgsSymbolWidgetContext& context );
+};
diff --git a/src/core/symbology-ng/qgspointdistancerenderer.cpp b/src/core/symbology-ng/qgspointdistancerenderer.cpp
@@ -350,6 +350,7 @@ QgsRectangle QgsPointDistanceRenderer::searchRect( const QgsPoint& p, double dis
 
 void QgsPointDistanceRenderer::printGroupInfo() const
 {
+#ifdef QGISDEBUG
   int nGroups = mClusteredGroups.size();
   QgsDebugMsg( "number of displacement groups:" + QString::number( nGroups ) );
   for ( int i = 0; i < nGroups; ++i )
@@ -360,6 +361,7 @@ void QgsPointDistanceRenderer::printGroupInfo() const
       QgsDebugMsg( FID_TO_STRING( feature.feature.id() ) );
     }
   }
+#endif
 }
 
 QString QgsPointDistanceRenderer::getLabel( const QgsFeature& feature ) const

diff --git a/src/core/symbology-ng/qgspointdistancerenderer.h b/src/core/symbology-ng/qgspointdistancerenderer.h
@@ -246,6 +246,7 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer
      * @param context destination render context
      * @param labelShifts displacement for individual label positions
      * @param group group of clustered features to label
+     * @note may not be available in Python bindings on some platforms
      */
     void drawLabels( QPointF centerPoint, QgsSymbolRenderContext& context, const QList<QPointF>& labelShifts, const ClusteredGroup& group );
 

diff --git a/src/gui/symbology-ng/qgspointclusterrendererwidget.h b/src/gui/symbology-ng/qgspointclusterrendererwidget.h
@@ -23,12 +23,32 @@
 
 class QgsPointClusterRenderer;
 
+/** \class QgsPointClusterRendererWidget
+ * \ingroup gui
+ * A widget which allows configuration of the properties for a QgsPointClusterRenderer.
+ * \note added in QGIS 3.0
+ */
+
 class GUI_EXPORT QgsPointClusterRendererWidget: public QgsRendererWidget, private Ui::QgsPointClusterRendererWidgetBase
 {
     Q_OBJECT
   public:
+
+    /** Returns a new QgsPointClusterRendererWidget.
+     * @param layer associated vector layer
+     * @param style style collection
+     * @param renderer source QgsPointClusterRenderer renderer
+     * @returns new QgsRendererWidget
+     */
     static QgsRendererWidget* create( QgsVectorLayer* layer, QgsStyle* style, QgsFeatureRenderer* renderer );
+
+    /** Constructor for QgsPointClusterRendererWidget.
+     * @param layer associated vector layer
+     * @param style style collection
+     * @param renderer source QgsPointClusterRenderer renderer
+     */
     QgsPointClusterRendererWidget( QgsVectorLayer* layer, QgsStyle* style, QgsFeatureRenderer* renderer );
+
     ~QgsPointClusterRendererWidget();
 
     QgsFeatureRenderer* renderer() override;

diff --git a/src/gui/symbology-ng/qgsrulebasedrendererwidget.h b/src/gui/symbology-ng/qgsrulebasedrendererwidget.h
@@ -240,7 +240,16 @@ class GUI_EXPORT QgsRendererRulePropsDialog : public QDialog
     Q_OBJECT
 
   public:
+
+    /** Constructor for QgsRendererRulePropsDialog
+     * @param rule associated rule based renderer rule
+     * @param layer source vector layer
+     * @param style style collection
+     * @param parent parent widget
+     * @param context symbol widget context
+     */
     QgsRendererRulePropsDialog( QgsRuleBasedRenderer::Rule* rule, QgsVectorLayer* layer, QgsStyle* style, QWidget* parent = nullptr, const QgsSymbolWidgetContext& context = QgsSymbolWidgetContext() );
+
     ~QgsRendererRulePropsDialog();
 
     QgsRuleBasedRenderer::Rule* rule() { return mPropsWidget->rule(); }

diff --git a/src/gui/symbology-ng/qgssymbolwidgetcontext.h b/src/gui/symbology-ng/qgssymbolwidgetcontext.h
@@ -33,6 +33,9 @@ class GUI_EXPORT QgsSymbolWidgetContext
 
     QgsSymbolWidgetContext();
 
+    /** Copy constructor.
+     * @param other source QgsSymbolWidgetContext
+     */
     QgsSymbolWidgetContext( const QgsSymbolWidgetContext& other );
 
     QgsSymbolWidgetContext& operator=( const QgsSymbolWidgetContext& other );