sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-11-30 00:04:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
Nyall Dawson 2017-06-09 09:14:50 +10:00
parent b07726592c
commit 10707b8787
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
python/gui/qgsscalerangewidget.sip
View File

@ -33,7 +33,7 @@ class QgsScaleRangeWidget : QWidget
double minimumScale() const; double minimumScale() const;
%Docstring %Docstring
Returns the selected minimum scale, or 0 if minimum scale is not set. Returns the selected minimum scale (i.e. most "zoomed out" scale), or 0 if minimum scale is not set.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
.. seealso:: maximumScale() .. seealso:: maximumScale()
.. seealso:: setMinimumScale() .. seealso:: setMinimumScale()
@ -42,7 +42,7 @@ class QgsScaleRangeWidget : QWidget
double maximumScale() const; double maximumScale() const;
%Docstring %Docstring
Returns the selected maximum scale, or 0 if maximum scale is not set. Returns the selected maximum scale (i.e. most "zoomed in" scale), or 0 if maximum scale is not set.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
.. seealso:: minimumScale() .. seealso:: minimumScale()
.. seealso:: setMaximumScale() .. seealso:: setMaximumScale()
@ -58,7 +58,7 @@ class QgsScaleRangeWidget : QWidget
void setMinimumScale( double scale ); void setMinimumScale( double scale );
%Docstring %Docstring
Set the minimum ``scale``, or 0 to indicate the minimum is not set. Set the minimum ``scale`` (i.e. most "zoomed out" scale), or 0 to indicate the minimum is not set.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
.. seealso:: minimumScale() .. seealso:: minimumScale()
.. seealso:: setMaximumScale() .. seealso:: setMaximumScale()
@ -67,7 +67,7 @@ class QgsScaleRangeWidget : QWidget
void setMaximumScale( double scale ); void setMaximumScale( double scale );
%Docstring %Docstring
Set the maximum ``scale``, or 0 to indicate the minimum is not set. Set the maximum ``scale`` (i.e. most "zoomed in" scale), or 0 to indicate the minimum is not set.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
.. seealso:: maximumScale() .. seealso:: maximumScale()
.. seealso:: setMinimumScale() .. seealso:: setMinimumScale()
@ -76,7 +76,7 @@ class QgsScaleRangeWidget : QWidget
void setScaleRange( double min, double max ); void setScaleRange( double min, double max );
%Docstring %Docstring
Sets the scale range, from ``min`` scale to ``max`` scale. Sets the scale range, from ``min`` scale (i.e. most "zoomed out" scale) to ``max`` scale (most "zoomed in" scale).
The scale values indicates the scale denominator, e.g. 1000.0 for a 1:1000 map, The scale values indicates the scale denominator, e.g. 1000.0 for a 1:1000 map,
or 0 to indicate not set. or 0 to indicate not set.
.. seealso:: setMinimumScale() .. seealso:: setMinimumScale()

10
src/gui/qgsscalerangewidget.h
View File

@ -49,7 +49,7 @@ class GUI_EXPORT QgsScaleRangeWidget : public QWidget
void setMapCanvas( QgsMapCanvas *canvas ); void setMapCanvas( QgsMapCanvas *canvas );
/** /**
* Returns the selected minimum scale, or 0 if minimum scale is not set. * Returns the selected minimum scale (i.e. most "zoomed out" scale), or 0 if minimum scale is not set.
* The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. * The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* \see maximumScale() * \see maximumScale()
* \see setMinimumScale() * \see setMinimumScale()
@ -57,7 +57,7 @@ class GUI_EXPORT QgsScaleRangeWidget : public QWidget
double minimumScale() const; double minimumScale() const;
/** /**
* Returns the selected maximum scale, or 0 if maximum scale is not set. * Returns the selected maximum scale (i.e. most "zoomed in" scale), or 0 if maximum scale is not set.
* The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. * The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* \see minimumScale() * \see minimumScale()
* \see setMaximumScale() * \see setMaximumScale()
@ -72,7 +72,7 @@ class GUI_EXPORT QgsScaleRangeWidget : public QWidget
public slots: public slots:
/** /**
* Set the minimum \a scale, or 0 to indicate the minimum is not set. * Set the minimum \a scale (i.e. most "zoomed out" scale), or 0 to indicate the minimum is not set.
* The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. * The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* \see minimumScale() * \see minimumScale()
* \see setMaximumScale() * \see setMaximumScale()
@ -81,7 +81,7 @@ class GUI_EXPORT QgsScaleRangeWidget : public QWidget
void setMinimumScale( double scale ); void setMinimumScale( double scale );
/** /**
* Set the maximum \a scale, or 0 to indicate the minimum is not set. * Set the maximum \a scale (i.e. most "zoomed in" scale), or 0 to indicate the minimum is not set.
* The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. * The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* \see maximumScale() * \see maximumScale()
* \see setMinimumScale() * \see setMinimumScale()
@ -90,7 +90,7 @@ class GUI_EXPORT QgsScaleRangeWidget : public QWidget
void setMaximumScale( double scale ); void setMaximumScale( double scale );
/** /**
* Sets the scale range, from \a min scale to \a max scale. * Sets the scale range, from \a min scale (i.e. most "zoomed out" scale) to \a max scale (most "zoomed in" scale).
* The scale values indicates the scale denominator, e.g. 1000.0 for a 1:1000 map, * The scale values indicates the scale denominator, e.g. 1000.0 for a 1:1000 map,
* or 0 to indicate not set. * or 0 to indicate not set.
* \see setMinimumScale() * \see setMinimumScale()