Add missing docs

qgis · Apr 26, 2017 · 8d24a9a · 8d24a9a
1 parent fa21311
commit 8d24a9a
Show file tree

Hide file tree

Showing 11 changed files with 54 additions and 2 deletions.
diff --git a/python/core/scalebar/qgsdoubleboxscalebarrenderer.sip b/python/core/scalebar/qgsdoubleboxscalebarrenderer.sip
@@ -19,7 +19,11 @@ class QgsDoubleBoxScaleBarRenderer: QgsScaleBarRenderer
 #include "qgsdoubleboxscalebarrenderer.h"
 %End
   public:
+
     QgsDoubleBoxScaleBarRenderer();
+%Docstring
+ Constructor for QgsDoubleBoxScaleBarRenderer.
+%End
 
     virtual QString name() const;
 

diff --git a/python/core/scalebar/qgsnumericscalebarrenderer.sip b/python/core/scalebar/qgsnumericscalebarrenderer.sip
@@ -19,7 +19,11 @@ class QgsNumericScaleBarRenderer: QgsScaleBarRenderer
 #include "qgsnumericscalebarrenderer.h"
 %End
   public:
+
     QgsNumericScaleBarRenderer();
+%Docstring
+ Constructor for QgsNumericScaleBarRenderer.
+%End
 
     virtual QString name() const;
 

diff --git a/python/core/scalebar/qgsscalebarrenderer.sip b/python/core/scalebar/qgsscalebarrenderer.sip
@@ -47,6 +47,9 @@ Scale denominator
     };
 
     QgsScaleBarRenderer();
+%Docstring
+ Constructor for QgsScaleBarRenderer.
+%End
     virtual ~QgsScaleBarRenderer();
 
     virtual QString name() const = 0;

diff --git a/python/core/scalebar/qgssingleboxscalebarrenderer.sip b/python/core/scalebar/qgssingleboxscalebarrenderer.sip
@@ -22,6 +22,9 @@ class QgsSingleBoxScaleBarRenderer: QgsScaleBarRenderer
   public:
 
     QgsSingleBoxScaleBarRenderer();
+%Docstring
+ Constructor for QgsSingleBoxScaleBarRenderer.
+%End
 
     virtual QString name() const;
 

diff --git a/python/core/scalebar/qgsticksscalebarrenderer.sip b/python/core/scalebar/qgsticksscalebarrenderer.sip
@@ -28,6 +28,9 @@ class QgsTicksScaleBarRenderer: QgsScaleBarRenderer
     };
 
     QgsTicksScaleBarRenderer();
+%Docstring
+ Constructor for QgsTicksScaleBarRenderer.
+%End
 
     virtual QString name() const;
 

diff --git a/src/core/composer/qgscomposerscalebar.h b/src/core/composer/qgscomposerscalebar.h
@@ -215,7 +215,14 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
     double height() const { return mSettings.height(); }
     void setHeight( double h ) { mSettings.setHeight( h );}
 
+    /**
+     * Sets the \a map item linked to the scalebar.
+     */
     void setComposerMap( QgsComposerMap *map );
+
+    /**
+     * Returns the map item linked to the scalebar.
+     */
     QgsComposerMap *composerMap() const {return mComposerMap;}
 
     double labelBarSpace() const {return mSettings.labelBarSpace();}
@@ -224,13 +231,24 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
     double boxContentSpace() const {return mSettings.boxContentSpace();}
     void setBoxContentSpace( double space );
 
-    //! Left / Middle/ Right
+    /**
+     * Returns the alignment of the scalebar.
+     */
     QgsScaleBarSettings::Alignment alignment() const { return mSettings.alignment(); }
 
-    void setAlignment( QgsScaleBarSettings::Alignment a );
+    /**
+     * Sets the \a alignment of the scalebar.
+     */
+    void setAlignment( QgsScaleBarSettings::Alignment alignment );
 
+    /**
+     * Returns the scalebar distance units.
+     */
     QgsUnitTypes::DistanceUnit units() const { return mSettings.units(); }
 
+    /**
+     * Sets the scalebar distance units.
+     */
     void setUnits( QgsUnitTypes::DistanceUnit u );
 
     /** Returns the join style used for drawing lines in the scalebar

diff --git a/src/core/scalebar/qgsdoubleboxscalebarrenderer.h b/src/core/scalebar/qgsdoubleboxscalebarrenderer.h
@@ -30,6 +30,10 @@
 class CORE_EXPORT QgsDoubleBoxScaleBarRenderer: public QgsScaleBarRenderer
 {
   public:
+
+    /**
+     * Constructor for QgsDoubleBoxScaleBarRenderer.
+     */
     QgsDoubleBoxScaleBarRenderer() = default;
 
     QString name() const override { return QStringLiteral( "Double Box" ); }

diff --git a/src/core/scalebar/qgsnumericscalebarrenderer.h b/src/core/scalebar/qgsnumericscalebarrenderer.h
@@ -30,6 +30,10 @@
 class CORE_EXPORT QgsNumericScaleBarRenderer: public QgsScaleBarRenderer
 {
   public:
+
+    /**
+     * Constructor for QgsNumericScaleBarRenderer.
+     */
     QgsNumericScaleBarRenderer() = default;
 
     QString name() const override { return QStringLiteral( "Numeric" ); }

diff --git a/src/core/scalebar/qgsscalebarrenderer.h b/src/core/scalebar/qgsscalebarrenderer.h
@@ -58,6 +58,9 @@ class CORE_EXPORT QgsScaleBarRenderer
 
     };
 
+    /**
+     * Constructor for QgsScaleBarRenderer.
+     */
     QgsScaleBarRenderer() = default;
     virtual ~QgsScaleBarRenderer() = default;
 

diff --git a/src/core/scalebar/qgssingleboxscalebarrenderer.h b/src/core/scalebar/qgssingleboxscalebarrenderer.h
@@ -32,6 +32,9 @@ class CORE_EXPORT QgsSingleBoxScaleBarRenderer: public QgsScaleBarRenderer
 {
   public:
 
+    /**
+     * Constructor for QgsSingleBoxScaleBarRenderer.
+     */
     QgsSingleBoxScaleBarRenderer() = default;
 
     QString name() const override { return QStringLiteral( "Single Box" ); }

diff --git a/src/core/scalebar/qgsticksscalebarrenderer.h b/src/core/scalebar/qgsticksscalebarrenderer.h
@@ -38,6 +38,9 @@ class CORE_EXPORT QgsTicksScaleBarRenderer: public QgsScaleBarRenderer
       TicksMiddle, //!< Render ticks crossing line
     };
 
+    /**
+     * Constructor for QgsTicksScaleBarRenderer.
+     */
     QgsTicksScaleBarRenderer() = default;
 
     QString name() const override;