Skip to content

Commit 09efa48

Browse files
uclarosnyalldawson
uclaros
authored andcommitted
Fixed notation of doxygen comments that were after a member
1 parent a020d47 commit 09efa48

23 files changed

+75
-75
lines changed

src/analysis/vector/geometry_checker/qgsgeometrymissingvertexcheck.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class ANALYSIS_EXPORT QgsGeometryMissingVertexCheck : public QgsGeometryCheck
4444
enum ResolutionMethod
4545
{
4646
NoChange, //!< Do nothing
47-
AddMissingVertex //! Add the missing vertex
47+
AddMissingVertex //!< Add the missing vertex
4848
};
4949
Q_ENUM( ResolutionMethod )
5050

src/app/qgsprojectproperties.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
195195
DecimalDegrees, //!< Decimal degrees
196196
DegreesMinutes, //!< Degrees, decimal minutes
197197
DegreesMinutesSeconds, //!< Degrees, minutes, seconds
198-
MapUnits, //! Show coordinates in map units
198+
MapUnits, //!< Show coordinates in map units
199199
};
200200

201201
QgsRelationManagerDialog *mRelationManagerDlg = nullptr;

src/core/layout/qgslayoutgridsettings.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ class CORE_EXPORT QgsLayoutGridSettings : public QgsLayoutSerializableObject
4040
//! Style for drawing the page/snapping grid
4141
enum Style
4242
{
43-
StyleLines, //! Solid lines
44-
StyleDots, //! Dots
45-
StyleCrosses //! Crosses
43+
StyleLines, //!< Solid lines
44+
StyleDots, //!< Dots
45+
StyleCrosses //!< Crosses
4646
};
4747

4848
/**

src/core/mesh/qgsmeshlayer.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ class CORE_EXPORT QgsMeshLayer : public QgsMapLayer
9696
*/
9797
struct LayerOptions
9898
{
99-
int unused; //! @todo remove me once there are actual members here (breaks SIP <4.19)
99+
int unused; //!< @todo remove me once there are actual members here (breaks SIP <4.19)
100100
};
101101

102102
/**

src/core/pal/pal.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ namespace pal
6262
POPMUSIC_TABU_CHAIN = 1, //!< Is the best but slowest
6363
POPMUSIC_TABU = 2, //!< Is a little bit better than CHAIN but slower
6464
POPMUSIC_CHAIN = 3, //!< Is slower and best than TABU, worse and faster than TABU_CHAIN
65-
FALP = 4 //! only initial solution
65+
FALP = 4 //!< only initial solution
6666
};
6767

6868
//! Enumeration line arrangement flags. Flags can be combined.

src/core/qgsaggregatecalculator.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ class CORE_EXPORT QgsAggregateCalculator
7979
InterQuartileRange, //!< Inter quartile range (IQR) (numeric fields only)
8080
StringMinimumLength, //!< Minimum length of string (string fields only)
8181
StringMaximumLength, //!< Maximum length of string (string fields only)
82-
StringConcatenate, //! Concatenate values with a joining string (string fields only). Specify the delimiter using setDelimiter().
83-
GeometryCollect, //! Create a multipart geometry from aggregated geometries
84-
ArrayAggregate //! Create an array of values
82+
StringConcatenate, //!< Concatenate values with a joining string (string fields only). Specify the delimiter using setDelimiter().
83+
GeometryCollect, //!< Create a multipart geometry from aggregated geometries
84+
ArrayAggregate //!< Create an array of values
8585
};
8686

8787
//! A bundle of parameters controlling aggregate calculation

src/core/qgsdataprovider.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ class CORE_EXPORT QgsDataProvider : public QObject
9494
*/
9595
struct ProviderOptions
9696
{
97-
int unused; //! @todo remove me once there are actual members here (breaks SIP <4.19)
97+
int unused; //!< @todo remove me once there are actual members here (breaks SIP <4.19)
9898
};
9999

100100
/**

src/core/qgsdatetimestatisticalsummary.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ class CORE_EXPORT QgsDateTimeStatisticalSummary
5555
Min = 8, //!< Minimum (earliest) datetime value
5656
Max = 16, //!< Maximum (latest) datetime value
5757
Range = 32, //!< Interval between earliest and latest datetime value
58-
All = Count | CountDistinct | CountMissing | Min | Max | Range, //! All statistics
58+
All = Count | CountDistinct | CountMissing | Min | Max | Range, //!< All statistics
5959
};
6060
Q_DECLARE_FLAGS( Statistics, Statistic )
6161

src/core/qgsdiagramrenderer.h

+9-9
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,15 @@ class CORE_EXPORT QgsDiagramLayerSettings
8989
BackgroundColor, //!< Diagram background color
9090
StrokeColor, //!< Stroke color
9191
StrokeWidth, //!< Stroke width
92-
PositionX, //! x-coordinate data defined diagram position
93-
PositionY, //! y-coordinate data defined diagram position
94-
Distance, //! Distance to diagram from feature
95-
Priority, //! Diagram priority (between 0 and 10)
96-
ZIndex, //! Z-index for diagram ordering
97-
IsObstacle, //! Whether diagram features act as obstacles for other diagrams/labels
98-
Show, //! Whether to show the diagram
99-
AlwaysShow, //! Whether the diagram should always be shown, even if it overlaps other diagrams/labels
100-
StartAngle, //! Angle offset for pie diagram
92+
PositionX, //!< x-coordinate data defined diagram position
93+
PositionY, //!< y-coordinate data defined diagram position
94+
Distance, //!< Distance to diagram from feature
95+
Priority, //!< Diagram priority (between 0 and 10)
96+
ZIndex, //!< Z-index for diagram ordering
97+
IsObstacle, //!< Whether diagram features act as obstacles for other diagrams/labels
98+
Show, //!< Whether to show the diagram
99+
AlwaysShow, //!< Whether the diagram should always be shown, even if it overlaps other diagrams/labels
100+
StartAngle, //!< Angle offset for pie diagram
101101
};
102102

103103
/**

src/core/qgsfeature_p.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class QgsFeaturePrivate : public QSharedData
6464
//! Feature ID
6565
QgsFeatureId fid;
6666

67-
///! Attributes accessed by field index
67+
//! Attributes accessed by field index
6868
QgsAttributes attributes;
6969

7070
//! Geometry, may be empty if feature has no geometry

src/core/qgsgml.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ class CORE_EXPORT QgsGmlStreamingParser
283283
//! Parsing depth
284284
int mParseDepth;
285285
int mFeatureTupleDepth;
286-
QString mCurrentTypename; //! Used to track the current (unprefixed) typename for wfs:Member in join layer
286+
QString mCurrentTypename; //!< Used to track the current (unprefixed) typename for wfs:Member in join layer
287287
//! Keep track about the most important nested elements
288288
QStack<ParseMode> mParseModeStack;
289289
//! This contains the character data if an important element has been encountered

src/core/qgsopenclutils.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ class CORE_EXPORT QgsOpenClUtils
8080
*/
8181
enum ExceptionBehavior
8282
{
83-
Catch, //! Write errors in the message log and silently fail
84-
Throw //! Write errors in the message log and re-throw exceptions
83+
Catch, //!< Write errors in the message log and silently fail
84+
Throw //!< Write errors in the message log and re-throw exceptions
8585
};
8686

8787
/**

src/core/qgspallabeling.h

+8-8
Original file line numberDiff line numberDiff line change
@@ -137,30 +137,30 @@ class CORE_EXPORT QgsPalLayerSettings
137137
enum Placement
138138
{
139139
AroundPoint, //!< Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygon layers only.
140-
OverPoint, //! Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point. Applies to point or polygon layers only.
140+
OverPoint, //!< Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point. Applies to point or polygon layers only.
141141
Line, //!< Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon's perimeter. Applies to line or polygon layers only.
142-
Curved, //! Arranges candidates following the curvature of a line feature. Applies to line layers only.
142+
Curved, //!< Arranges candidates following the curvature of a line feature. Applies to line layers only.
143143
Horizontal, //!< Arranges horizontal candidates scattered throughout a polygon feature. Applies to polygon layers only.
144144
Free, //!< Arranges candidates scattered throughout a polygon feature. Candidates are rotated to respect the polygon's orientation. Applies to polygon layers only.
145145
OrderedPositionsAroundPoint, //!< Candidates are placed in predefined positions around a point. Preference is given to positions with greatest cartographic appeal, e.g., top right, bottom right, etc. Applies to point layers only.
146-
PerimeterCurved, //! Arranges candidates following the curvature of a polygon's boundary. Applies to polygon layers only.
146+
PerimeterCurved, //!< Arranges candidates following the curvature of a polygon's boundary. Applies to polygon layers only.
147147
};
148148

149149
//TODO QGIS 4.0 - move to QgsLabelingEngine
150150
//! Positions for labels when using the QgsPalLabeling::OrderedPositionsAroundPoint placement mode
151151
enum PredefinedPointPosition
152152
{
153153
TopLeft, //!< Label on top-left of point
154-
TopSlightlyLeft, //! Label on top of point, slightly left of center
154+
TopSlightlyLeft, //!< Label on top of point, slightly left of center
155155
TopMiddle, //!< Label directly above point
156-
TopSlightlyRight, //! Label on top of point, slightly right of center
156+
TopSlightlyRight, //!< Label on top of point, slightly right of center
157157
TopRight, //!< Label on top-right of point
158158
MiddleLeft, //!< Label on left of point
159159
MiddleRight, //!< Label on right of point
160160
BottomLeft, //!< Label on bottom-left of point
161-
BottomSlightlyLeft, //! Label below point, slightly left of center
161+
BottomSlightlyLeft, //!< Label below point, slightly left of center
162162
BottomMiddle, //!< Label directly below point
163-
BottomSlightlyRight, //! Label below point, slightly right of center
163+
BottomSlightlyRight, //!< Label below point, slightly right of center
164164
BottomRight, //!< Label on bottom right of point
165165
};
166166

@@ -268,7 +268,7 @@ class CORE_EXPORT QgsPalLayerSettings
268268
FontCase = 27, //!< Label text case
269269
FontLetterSpacing = 28, //!< Letter spacing
270270
FontWordSpacing = 29, //!< Word spacing
271-
FontBlendMode = 30, //! Text blend mode
271+
FontBlendMode = 30, //!< Text blend mode
272272

273273
// text formatting
274274
MultiLineWrapChar = 31,

src/core/qgsproperty.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ class CORE_EXPORT QgsProperty
233233
//! Property types
234234
enum Type
235235
{
236-
InvalidProperty, //! Invalid (not set) property
236+
InvalidProperty, //!< Invalid (not set) property
237237
StaticProperty, //!< Static property (QgsStaticProperty)
238238
FieldBasedProperty, //!< Field based property (QgsFieldBasedProperty)
239239
ExpressionBasedProperty, //!< Expression based property (QgsExpressionBasedProperty)

src/core/qgsstringstatisticalsummary.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ class CORE_EXPORT QgsStringStatisticalSummary
5555
MinimumLength = 32, //!< Minimum length of string
5656
MaximumLength = 64, //!< Maximum length of string
5757
MeanLength = 128, //!< Mean length of strings
58-
All = Count | CountDistinct | CountMissing | Min | Max | MinimumLength | MaximumLength | MeanLength, //! All statistics
58+
All = Count | CountDistinct | CountMissing | Min | Max | MinimumLength | MaximumLength | MeanLength, //!< All statistics
5959
};
6060
Q_DECLARE_FLAGS( Statistics, Statistic )
6161

src/core/qgsunittypes.h

+4-4
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ class CORE_EXPORT QgsUnitTypes
8888
AreaAcres, //!< Acres
8989
AreaSquareNauticalMiles, //!< Square nautical miles
9090
AreaSquareDegrees, //!< Square degrees, for planar geographic CRS area measurements
91-
AreaSquareCentimeters, //! Square centimeters
92-
AreaSquareMillimeters, //! Square millimeters
91+
AreaSquareCentimeters, //!< Square centimeters
92+
AreaSquareMillimeters, //!< Square millimeters
9393
AreaUnknownUnit, //!< Unknown areal unit
9494
};
9595
Q_ENUM( AreaUnit )
@@ -114,8 +114,8 @@ class CORE_EXPORT QgsUnitTypes
114114
RenderMapUnits, //!< Map units
115115
RenderPixels, //!< Pixels
116116
RenderPercentage, //!< Percentage of another measurement (e.g., canvas size, feature size)
117-
RenderPoints, //! points (e.g., for font sizes)
118-
RenderInches, //! Inches
117+
RenderPoints, //!< points (e.g., for font sizes)
118+
RenderInches, //!< Inches
119119
RenderUnknownUnit, //!< Mixed or unknown units
120120
RenderMetersInMapUnits, //!< Meters value as Map units
121121
};

src/gui/qgsfilewidget.h

+4-4
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ class GUI_EXPORT QgsFileWidget : public QWidget
6262
*/
6363
enum StorageMode
6464
{
65-
GetFile, //! Select a single file
66-
GetDirectory, //! Select a directory
67-
GetMultipleFiles, //! Select multiple files
68-
SaveFile, //! Select a single new or pre-existing file
65+
GetFile, //!< Select a single file
66+
GetDirectory, //!< Select a directory
67+
GetMultipleFiles, //!< Select multiple files
68+
SaveFile, //!< Select a single new or pre-existing file
6969
};
7070

7171
/**

src/providers/ogr/qgsgeopackagerasterwriter.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class QgsGeoPackageRasterWriter
3131
enum WriterError
3232
{
3333
NoError = 0, //!< No errors were encountered
34-
WriteError, //! Generic GDAL Translate error
34+
WriteError, //!< Generic GDAL Translate error
3535
ErrUserCanceled, //!< User canceled the export
3636
};
3737

src/providers/oracle/qgsoraclefeatureiterator.h

+5-5
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ class QgsOracleFeatureSource : public QgsAbstractFeatureSource
3939
QgsDataSourceUri mUri;
4040
QgsFields mFields;
4141

42-
QString mGeometryColumn; //! name of the geometry column
43-
int mSrid; //! srid of column
44-
bool mHasSpatialIndex; //! has spatial index of geometry column
45-
QgsWkbTypes::Type mDetectedGeomType; //! geometry type detected in the database
46-
QgsWkbTypes::Type mRequestedGeomType; //! geometry type requested in the uri
42+
QString mGeometryColumn; //!< name of the geometry column
43+
int mSrid; //!< srid of column
44+
bool mHasSpatialIndex; //!< has spatial index of geometry column
45+
QgsWkbTypes::Type mDetectedGeomType; //!< geometry type detected in the database
46+
QgsWkbTypes::Type mRequestedGeomType; //!< geometry type requested in the uri
4747
QString mSqlWhereClause;
4848
QgsOraclePrimaryKeyType mPrimaryKeyType;
4949
QList<int> mPrimaryKeyAttrs;

src/providers/oracle/qgsoracleprovider.h

+13-13
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,8 @@ class QgsOracleProvider : public QgsVectorDataProvider
190190
//! Convert a QgsField to work with Oracle
191191
static bool convertField( QgsField &field );
192192

193-
QgsFields mAttributeFields; //! List of fields
194-
QVariantList mDefaultValues; //! List of default values
193+
QgsFields mAttributeFields; //!< List of fields
194+
QVariantList mDefaultValues; //!< List of default values
195195
QString mDataComment;
196196

197197
//! Data source URI struct for this layer
@@ -238,14 +238,14 @@ class QgsOracleProvider : public QgsVectorDataProvider
238238
QList<int> mPrimaryKeyAttrs;
239239
QString mPrimaryKeyDefault;
240240

241-
QString mGeometryColumn; //! name of the geometry column
242-
mutable QgsRectangle mLayerExtent; //! Rectangle that contains the extent (bounding box) of the layer
243-
mutable long mFeaturesCounted; //! Number of features in the layer
244-
int mSrid; //! srid of column
245-
QgsVectorDataProvider::Capabilities mEnabledCapabilities; //! capabilities of layer
241+
QString mGeometryColumn; //!< name of the geometry column
242+
mutable QgsRectangle mLayerExtent; //!< Rectangle that contains the extent (bounding box) of the layer
243+
mutable long mFeaturesCounted; //!< Number of features in the layer
244+
int mSrid; //!< srid of column
245+
QgsVectorDataProvider::Capabilities mEnabledCapabilities; //!< capabilities of layer
246246

247-
QgsWkbTypes::Type mDetectedGeomType; //! geometry type detected in the database
248-
QgsWkbTypes::Type mRequestedGeomType; //! geometry type requested in the uri
247+
QgsWkbTypes::Type mDetectedGeomType; //!< geometry type detected in the database
248+
QgsWkbTypes::Type mRequestedGeomType; //!< geometry type requested in the uri
249249

250250
bool getGeometryDetails();
251251

@@ -299,12 +299,12 @@ class QgsOracleProvider : public QgsVectorDataProvider
299299
static QString quotedIdentifier( QString ident ) { return QgsOracleConn::quotedIdentifier( ident ); }
300300
static QString quotedValue( const QVariant &value, QVariant::Type type = QVariant::Invalid ) { return QgsOracleConn::quotedValue( value, type ); }
301301

302-
QMap<QVariant, QgsFeatureId> mKeyToFid; //! map key values to feature id
303-
QMap<QgsFeatureId, QVariant> mFidToKey; //! map feature back to fea
302+
QMap<QVariant, QgsFeatureId> mKeyToFid; //!< map key values to feature id
303+
QMap<QgsFeatureId, QVariant> mFidToKey; //!< map feature back to fea
304304
QgsOracleConn *mConnection = nullptr;
305305

306-
bool mHasSpatialIndex; //! Geometry column is indexed
307-
QString mSpatialIndexName; //! name of spatial index of geometry column
306+
bool mHasSpatialIndex; //!< Geometry column is indexed
307+
QString mSpatialIndexName; //!< name of spatial index of geometry column
308308

309309
std::shared_ptr<QgsOracleSharedData> mShared;
310310

src/providers/postgres/qgspostgresconn.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ class QgsPostgresConn : public QObject
431431

432432
int mNextCursorId;
433433

434-
bool mShared; //! < whether the connection is shared by more providers (must not be if going to be used in worker threads)
434+
bool mShared; //!< whether the connection is shared by more providers (must not be if going to be used in worker threads)
435435

436436
bool mTransaction;
437437

src/providers/postgres/qgspostgresfeatureiterator.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ class QgsPostgresFeatureSource : public QgsAbstractFeatureSource
4444
QgsPostgresGeometryColumnType mSpatialColType;
4545
QString mRequestedSrid;
4646
QString mDetectedSrid;
47-
QgsWkbTypes::Type mRequestedGeomType; //! geometry type requested in the uri
48-
QgsWkbTypes::Type mDetectedGeomType; //! geometry type detected in the database
47+
QgsWkbTypes::Type mRequestedGeomType; //!< geometry type requested in the uri
48+
QgsWkbTypes::Type mDetectedGeomType; //!< geometry type detected in the database
4949
QgsPostgresPrimaryKeyType mPrimaryKeyType;
5050
QList<int> mPrimaryKeyAttrs;
5151
QString mQuery;

src/providers/postgres/qgspostgresprovider.h

+10-10
Original file line numberDiff line numberDiff line change
@@ -378,13 +378,13 @@ class QgsPostgresProvider : public QgsVectorDataProvider
378378
QList<int> mPrimaryKeyAttrs;
379379
QString mPrimaryKeyDefault;
380380

381-
QString mGeometryColumn; //! name of the geometry column
382-
mutable QgsRectangle mLayerExtent; //! Rectangle that contains the extent (bounding box) of the layer
381+
QString mGeometryColumn; //!< name of the geometry column
382+
mutable QgsRectangle mLayerExtent; //!< Rectangle that contains the extent (bounding box) of the layer
383383

384-
QgsWkbTypes::Type mDetectedGeomType = QgsWkbTypes::Unknown ; //! geometry type detected in the database
385-
QgsWkbTypes::Type mRequestedGeomType = QgsWkbTypes::Unknown ; //! geometry type requested in the uri
386-
QString mDetectedSrid; //! Spatial reference detected in the database
387-
QString mRequestedSrid; //! Spatial reference requested in the uri
384+
QgsWkbTypes::Type mDetectedGeomType = QgsWkbTypes::Unknown ; //!< geometry type detected in the database
385+
QgsWkbTypes::Type mRequestedGeomType = QgsWkbTypes::Unknown ; //!< geometry type requested in the uri
386+
QString mDetectedSrid; //!< Spatial reference detected in the database
387+
QString mRequestedSrid; //!< Spatial reference requested in the uri
388388

389389
std::shared_ptr<QgsPostgresSharedData> mShared; //!< Mutable data shared between provider and feature sources
390390

@@ -409,7 +409,7 @@ class QgsPostgresProvider : public QgsVectorDataProvider
409409
/* Use estimated metadata. Uses fast table counts, geometry type and extent determination */
410410
bool mUseEstimatedMetadata = false;
411411

412-
bool mSelectAtIdDisabled = false; //! Disable support for SelectAtId
412+
bool mSelectAtIdDisabled = false; //!< Disable support for SelectAtId
413413

414414
struct PGFieldNotFound {}; //! Exception to throw
415415

@@ -438,8 +438,8 @@ class QgsPostgresProvider : public QgsVectorDataProvider
438438

439439
QString paramValue( const QString &fieldvalue, const QString &defaultValue ) const;
440440

441-
QgsPostgresConn *mConnectionRO = nullptr ; //! read-only database connection (initially)
442-
QgsPostgresConn *mConnectionRW = nullptr ; //! read-write database connection (on update)
441+
QgsPostgresConn *mConnectionRO = nullptr ; //!< read-only database connection (initially)
442+
QgsPostgresConn *mConnectionRW = nullptr ; //!< read-write database connection (on update)
443443

444444
QgsPostgresConn *connectionRO() const;
445445
QgsPostgresConn *connectionRW();
@@ -530,7 +530,7 @@ class QgsPostgresSharedData
530530
protected:
531531
QMutex mMutex; //!< Access to all data members is guarded by the mutex
532532

533-
long mFeaturesCounted = -1 ; //! Number of features in the layer
533+
long mFeaturesCounted = -1 ; //!< Number of features in the layer
534534

535535
QgsFeatureId mFidCounter = 0; // next feature id if map is used
536536
QMap<QVariantList, QgsFeatureId> mKeyToFid; // map key values to feature id

0 commit comments

Comments
 (0)