Skip to content

Commit fcacb0d

Browse files
committed
doxygen fixes
1 parent ca4bfb1 commit fcacb0d

File tree

76 files changed

+319
-252
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+319
-252
lines changed

doc/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ IF(WITH_APIDOC)
6060
${CMAKE_SOURCE_DIR}/src/core/diagram
6161
${CMAKE_SOURCE_DIR}/src/core/dxf
6262
${CMAKE_SOURCE_DIR}/src/core/effects
63-
${CMAKE_SOURCE_DIR}/src/core/expressions
63+
${CMAKE_SOURCE_DIR}/src/core/expression
6464
${CMAKE_SOURCE_DIR}/src/core/fieldformatter
6565
${CMAKE_SOURCE_DIR}/src/core/geometry
6666
${CMAKE_SOURCE_DIR}/src/core/geocms

python/core/expression/qgsexpression.sip.in

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -485,8 +485,6 @@ Returns the help text for a specified function.
485485
Returns the help text for a specified variable.
486486

487487
:param variableName: name of variable
488-
:param showValue: set to true to include current value of variable in help text
489-
:param value: current value of variable to show in help text
490488

491489
.. seealso:: :py:func:`helpText`
492490

python/core/geometry/qgsgeometryutils.sip.in

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -147,12 +147,14 @@ supported and is retrieved from the first 3D point amongst ``p1`` and
147147
Compute the intersection of a line and a circle.
148148
If the intersection has two solutions (points),
149149
the closest point to the initial ``intersection`` point is returned.
150-
@param center the center of the circle
151-
@param radius the radius of the circle
152-
@param linePoint1 a first point on the line
153-
@param linePoint2 a second point on the line
154-
@param intersection the initial point and the returned intersection point
155-
@return true if an intersection has been found
150+
151+
:param center: the center of the circle
152+
:param radius: the radius of the circle
153+
:param linePoint1: a first point on the line
154+
:param linePoint2: a second point on the line
155+
:param intersection: the initial point and the returned intersection point
156+
157+
:return: true if an intersection has been found
156158
%End
157159

158160
static int circleCircleIntersections( QgsPointXY center1, double radius1,

python/gui/editorwidgets/qgsdatetimeedit.sip.in

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ Resets the widget to show no value (ie, an "unknown" state).
7777
void valueChanged( const QDateTime &date );
7878
%Docstring
7979
signal emitted whenever the value changes.
80-
@param date the new date/time value.
80+
81+
:param date: the new date/time value.
8182
%End
8283

8384
protected:

python/gui/qgsattributeeditorcontext.sip.in

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,55 @@ Constructor for QgsAttributeEditorContext
4848
QgsAttributeEditorContext( const QgsAttributeEditorContext &parentContext, const QgsRelation &relation, RelationMode relationMode, FormMode widgetMode );
4949

5050
void setDistanceArea( const QgsDistanceArea &distanceArea );
51+
%Docstring
52+
Sets distance area object for area/length calculations
53+
54+
:param distanceArea: map canvas
55+
56+
.. seealso:: :py:func:`setDistanceArea`
57+
58+
.. versionadded:: 2.2
59+
%End
5160

5261
const QgsDistanceArea &distanceArea() const;
5362

5463
void setMapCanvas( QgsMapCanvas *mapCanvas );
64+
%Docstring
65+
Sets the map canvas (e.g. to zoom to related features)
66+
67+
:param mapCanvas: map canvas
68+
69+
.. seealso:: :py:func:`mapCanvas`
70+
71+
.. versionadded:: 3.2
72+
%End
5573
QgsMapCanvas *mapCanvas() const;
5674

5775
void setVectorLayerTools( QgsVectorLayerTools *vlTools );
76+
%Docstring
77+
Sets the vector layer tools
78+
79+
:param vlTools: vector layer tools
80+
81+
.. seealso:: :py:func:`vectorLayerTools`
82+
83+
.. versionadded:: 2.2
84+
%End
5885
const QgsVectorLayerTools *vectorLayerTools() const;
5986

6087
void setRelation( const QgsRelation &relation, RelationMode mode );
88+
%Docstring
89+
Set attribute relation and mode
90+
91+
:param relation: relation
92+
:param mode: relation mode
93+
94+
.. seealso:: :py:func:`relation`
95+
96+
.. seealso:: :py:func:`relationMode`
97+
98+
.. versionadded:: 2.6
99+
%End
61100
const QgsRelation &relation() const;
62101
RelationMode relationMode() const;
63102

python/gui/qgsoptionsdialoghighlightwidget.sip.in

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ This uses stylesheets.
2929
%Docstring
3030
create a highlight widget implementation for the proper widget type.
3131
For instance a QgsOptionsDialogHighlightButton for button.
32-
@return a QgsOptionsDialogHighlightWidget or a None if there is no implementation
32+
33+
:return: a QgsOptionsDialogHighlightWidget or a None if there is no implementation
3334
for the given widget.
3435
%End
3536

python/server/qgsserverprojectutils.sip.in

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,8 @@ Returns the WFS service url defined in a QGIS project.
355355
Returns the Layer ids list defined in a QGIS project as published in WFS.
356356

357357
:param project: the QGIS project
358-
@return the Layer ids list.
358+
359+
:return: the Layer ids list.
359360
%End
360361

361362

@@ -365,31 +366,35 @@ Returns the Layer precision defined in a QGIS project for the WFS GetFeature.
365366

366367
:param project: the QGIS project
367368
:param layerId: the layer id in the project
368-
@return the layer precision for WFS GetFeature.
369+
370+
:return: the layer precision for WFS GetFeature.
369371
%End
370372

371373
QStringList wfstUpdateLayerIds( const QgsProject &project );
372374
%Docstring
373375
Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities.
374376

375377
:param project: the QGIS project
376-
@return the Layer ids list.
378+
379+
:return: the Layer ids list.
377380
%End
378381

379382
QStringList wfstInsertLayerIds( const QgsProject &project );
380383
%Docstring
381384
Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities.
382385

383386
:param project: the QGIS project
384-
@return the Layer ids list.
387+
388+
:return: the Layer ids list.
385389
%End
386390

387391
QStringList wfstDeleteLayerIds( const QgsProject &project );
388392
%Docstring
389393
Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities.
390394

391395
:param project: the QGIS project
392-
@return the Layer ids list.
396+
397+
:return: the Layer ids list.
393398
%End
394399

395400
QString wcsServiceUrl( const QgsProject &project );

python/server/qgsserverrequest.sip.in

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@ Remove a parameter
9494
Return the header value
9595

9696
:param name: of the header
97-
@return the header value or an empty string
97+
98+
:return: the header value or an empty string
9899
%End
99100

100101
void setHeader( const QString &name, const QString &value );
@@ -108,7 +109,8 @@ Set an header
108109
QMap<QString, QString> headers() const;
109110
%Docstring
110111
Return the header map
111-
@return the headers map
112+
113+
:return: the headers map
112114
%End
113115

114116
void removeHeader( const QString &name );

src/3d/terrain/quantizedmeshgeometry.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@
2626
#define GZIP_CHUNK_SIZE 32 * 1024
2727

2828
/**
29-
* @brief Decompresses the given buffer using the standard GZIP algorithm
30-
* @param input The buffer to be decompressed
31-
* @param output The result of the decompression
32-
* @return @c true if the decompression was successful, @c false otherwise
29+
* \brief Decompresses the given buffer using the standard GZIP algorithm
30+
* \param input The buffer to be decompressed
31+
* \param output The result of the decompression
32+
* \return \c true if the decompression was successful, \c false otherwise
3333
*/
3434
bool gzipDecompress( QByteArray input, QByteArray &output )
3535
{

src/app/qgis-mime.ico

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)