Skip to content

Commit 03f8017

Browse files
committed
fix missing \returns in source
1 parent bd32078 commit 03f8017

File tree

6 files changed

+16
-9
lines changed

6 files changed

+16
-9
lines changed

src/analysis/interpolation/qgsinterpolator.h

+3-2
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,10 @@ class ANALYSIS_EXPORT QgsInterpolator
110110
* Calculates interpolation value for map coordinates x, y
111111
* \param x x-coordinate (in map units)
112112
* \param y y-coordinate (in map units)
113-
* \param result out: interpolation result
113+
* \param result interpolation result
114114
* \param feedback optional feedback object for progress and cancelation support
115-
* \returns 0 in case of success*/
115+
* \returns 0 in case of success
116+
*/
116117
virtual int interpolatePoint( double x, double y, double &result SIP_OUT, QgsFeedback *feedback = nullptr ) = 0;
117118

118119
//! \note not available in Python bindings

src/core/geometry/qgsgeometry.h

+1
Original file line numberDiff line numberDiff line change
@@ -876,6 +876,7 @@ class CORE_EXPORT QgsGeometry
876876
* \param center Center of the minimal enclosing circle returneds
877877
* \param radius Radius of the minimal enclosing circle returned
878878
* \param segments Number of segments used to segment geometry. \see QgsEllipse::toPolygon()
879+
* \returns the minimal enclosing circle as a QGIS geometry
879880
* \since QGIS 3.0
880881
*/
881882
QgsGeometry minimalEnclosingCircle( QgsPointXY &center SIP_OUT, double &radius SIP_OUT, unsigned int segments = 36 ) const;

src/core/qgsunittypes.h

+2
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,7 @@ class CORE_EXPORT QgsUnitTypes
226226
* Converts a translated string to a distance unit.
227227
* \param string string representing a distance unit
228228
* \param ok optional boolean, will be set to true if string was converted successfully
229+
* \returns the distance unit
229230
* \see toString()
230231
*/
231232
Q_INVOKABLE static QgsUnitTypes::DistanceUnit stringToDistanceUnit( const QString &string, bool *ok SIP_OUT = nullptr );
@@ -282,6 +283,7 @@ class CORE_EXPORT QgsUnitTypes
282283
* Converts a translated string to an areal unit.
283284
* \param string string representing an areal unit
284285
* \param ok optional boolean, will be set to true if string was converted successfully
286+
* \returns the area unit
285287
* \see toString()
286288
*/
287289
Q_INVOKABLE static AreaUnit stringToAreaUnit( const QString &string, bool *ok SIP_OUT = nullptr );

src/core/qgsvectorlayerjoinbuffer.h

+5-3
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,11 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject, public QgsFeatureSi
8181

8282
/**
8383
* Finds the vector join for a layer field index.
84-
\param index this layers attribute index
85-
\param fields fields of the vector layer (including joined fields)
86-
\param sourceFieldIndex Output: field's index in source layer */
84+
* \param index this layers attribute index
85+
* \param fields fields of the vector layer (including joined fields)
86+
* \param sourceFieldIndex Output: field's index in source layer
87+
* \returns the vector layer join info
88+
*/
8789
const QgsVectorLayerJoinInfo *joinForFieldIndex( int index, const QgsFields &fields, int &sourceFieldIndex SIP_OUT ) const;
8890

8991
/**

src/core/qgsziputils.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ namespace QgsZipUtils
3838
CORE_EXPORT bool isZipFile( const QString &filename );
3939

4040
/**
41-
* Unzip a zip file in an output directory. An error is returned if the zip
42-
* filename does not exist, the output directory does not exist or is
43-
* not writable.
41+
* Unzip a zip file in an output directory.
4442
* \param zip The zip filename
4543
* \param dir The output directory
4644
* \param files The absolute path of unzipped files
45+
* \returns false if the zip filename does not exist, the output directory
46+
* does not exist or is not writable.
4747
* \since QGIS 3.0
4848
*/
4949
CORE_EXPORT bool unzip( const QString &zip, const QString &dir, QStringList &files SIP_OUT );

src/gui/qgsexpressionlineedit.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,9 @@ class GUI_EXPORT QgsExpressionLineEdit : public QWidget
118118
QString expression() const;
119119

120120
/**
121-
* Returns true if the current expression is valid.
121+
* Determines if the current expression is valid.
122122
* \param expressionError will be set to any generated error message if specified
123+
* \returns true if the current expression is valid.
123124
*/
124125
bool isValidExpression( QString *expressionError SIP_OUT = nullptr ) const;
125126

0 commit comments

Comments
 (0)