From 8d24a9a189e9789b564bd32d046466a1a95f5cf0 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Sun, 23 Apr 2017 08:06:03 +1000 Subject: [PATCH] Add missing docs --- .../scalebar/qgsdoubleboxscalebarrenderer.sip | 4 ++++ .../scalebar/qgsnumericscalebarrenderer.sip | 4 ++++ python/core/scalebar/qgsscalebarrenderer.sip | 3 +++ .../scalebar/qgssingleboxscalebarrenderer.sip | 3 +++ .../scalebar/qgsticksscalebarrenderer.sip | 3 +++ src/core/composer/qgscomposerscalebar.h | 22 +++++++++++++++++-- .../scalebar/qgsdoubleboxscalebarrenderer.h | 4 ++++ .../scalebar/qgsnumericscalebarrenderer.h | 4 ++++ src/core/scalebar/qgsscalebarrenderer.h | 3 +++ .../scalebar/qgssingleboxscalebarrenderer.h | 3 +++ src/core/scalebar/qgsticksscalebarrenderer.h | 3 +++ 11 files changed, 54 insertions(+), 2 deletions(-) diff --git a/python/core/scalebar/qgsdoubleboxscalebarrenderer.sip b/python/core/scalebar/qgsdoubleboxscalebarrenderer.sip index 88fee9494b9..665583872d5 100644 --- 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 index e8b12daf1de..31e79f80808 100644 --- 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 index 2bbc6c7da24..65cafa0820a 100644 --- 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 index e9855a9b110..268c6027727 100644 --- 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 index 18768445cef..d0af4c8ca98 100644 --- 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 index 182bc11218d..2b595a8c435 100644 --- 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 index 8443ec0a0cf..1971823758a 100644 --- 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 index 68284f226aa..b18925e4446 100644 --- 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 index cbe590faf2e..94c752fd458 100644 --- 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 index a58ae418e3c..72481b2de05 100644 --- 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 index 25e1e874619..9af953bc8cc 100644 --- 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;