Add some missing dox and reference

qgis · Feb 6, 2020 · 224d6bc · 224d6bc
1 parent 6bffe18
commit 224d6bc
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 6 deletions.
diff --git a/python/core/auto_generated/qgsrendercontext.sip.in b/python/core/auto_generated/qgsrendercontext.sip.in
@@ -282,11 +282,15 @@ of any faster raster shortcuts.
     bool useAdvancedEffects() const;
 %Docstring
 Returns ``True`` if advanced effects such as blend modes such be used
+
+.. seealso:: :py:func:`setUseAdvancedEffects`
 %End
 
     void setUseAdvancedEffects( bool enabled );
 %Docstring
 Used to enable or disable advanced effects such as blend modes
+
+.. seealso:: :py:func:`useAdvancedEffects`
 %End
 
     bool drawEditingInformation() const;
@@ -479,9 +483,16 @@ Sets whether vector selections should be shown in the rendered map
     bool useRenderingOptimization() const;
 %Docstring
 Returns ``True`` if the rendering optimization (geometry simplification) can be executed
+
+.. seealso:: :py:func:`setUseRenderingOptimization`
 %End
 
     void setUseRenderingOptimization( bool enabled );
+%Docstring
+Sets whether the rendering optimization (geometry simplification) should be executed
+
+.. seealso:: :py:func:`useRenderingOptimization`
+%End
 
     const QgsVectorSimplifyMethod &vectorSimplifyMethod() const;
 %Docstring
@@ -565,22 +576,36 @@ Gets the filter feature provider used for additional filtering of rendered featu
 %Docstring
 Sets the segmentation tolerance applied when rendering curved geometries
 
-:param tolerance: the segmentation tolerance*
+:param tolerance: the segmentation tolerance
+
+.. seealso:: :py:func:`segmentationTolerance`
+
+.. seealso:: :py:func:`segmentationToleranceType`
 %End
+
     double segmentationTolerance() const;
 %Docstring
 Gets the segmentation tolerance applied when rendering curved geometries
+
+.. seealso:: :py:func:`setSegmentationTolerance`
 %End
 
     void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type );
 %Docstring
 Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)
 
-:param type: the segmentation tolerance typename*
+:param type: the segmentation tolerance typename
+
+.. seealso:: :py:func:`segmentationToleranceType`
+
+.. seealso:: :py:func:`segmentationTolerance`
 %End
+
     QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const;
 %Docstring
 Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)
+
+.. seealso:: :py:func:`setSegmentationToleranceType`
 %End
 
 

diff --git a/src/core/qgsrendercontext.h b/src/core/qgsrendercontext.h
@@ -331,11 +331,15 @@ class CORE_EXPORT QgsRenderContext
 
     /**
      * Returns TRUE if advanced effects such as blend modes such be used
+     *
+     * \see setUseAdvancedEffects()
      */
     bool useAdvancedEffects() const;
 
     /**
      * Used to enable or disable advanced effects such as blend modes
+     *
+     * \see useAdvancedEffects()
      */
     void setUseAdvancedEffects( bool enabled );
 
@@ -519,9 +523,16 @@ class CORE_EXPORT QgsRenderContext
 
     /**
      * Returns TRUE if the rendering optimization (geometry simplification) can be executed
+     *
+     * \see setUseRenderingOptimization()
      */
     bool useRenderingOptimization() const;
 
+    /**
+     * Sets whether the rendering optimization (geometry simplification) should be executed
+     *
+     * \see useRenderingOptimization()
+     */
     void setUseRenderingOptimization( bool enabled );
 
     /**
@@ -597,16 +608,30 @@ class CORE_EXPORT QgsRenderContext
 
     /**
      * Sets the segmentation tolerance applied when rendering curved geometries
-    \param tolerance the segmentation tolerance*/
+     * \param tolerance the segmentation tolerance
+     * \see segmentationTolerance()
+     * \see segmentationToleranceType()
+     */
     void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; }
-    //! Gets the segmentation tolerance applied when rendering curved geometries
+
+    /**
+     * Gets the segmentation tolerance applied when rendering curved geometries
+     * \see setSegmentationTolerance()
+     */
     double segmentationTolerance() const { return mSegmentationTolerance; }
 
     /**
      * Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)
-    \param type the segmentation tolerance typename*/
+     * \param type the segmentation tolerance typename
+     * \see segmentationToleranceType()
+     * \see segmentationTolerance()
+     */
     void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ) { mSegmentationToleranceType = type; }
-    //! Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)
+
+    /**
+     * Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)
+     * \see setSegmentationToleranceType()
+     */
     QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const { return mSegmentationToleranceType; }
 
     // Conversions