From 78c0c284687ee89c991d829ae7fc9d13a91ddbe4 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Thu, 5 Oct 2017 13:40:11 +1000 Subject: [PATCH] Fix doxygen warnings --- python/core/layertree/qgslayertreemodel.sip | 4 ++-- python/core/qgspointlocator.sip | 10 ++++++---- src/core/layertree/qgslayertreemodel.h | 4 ++-- src/core/qgspointlocator.h | 10 ++++++---- src/gui/qgsprojectionselectiontreewidget.cpp | 2 +- src/gui/qgsprojectionselectiontreewidget.h | 5 ++--- 6 files changed, 19 insertions(+), 16 deletions(-) diff --git a/python/core/layertree/qgslayertreemodel.sip b/python/core/layertree/qgslayertreemodel.sip index f5d3353d4e5..5e976ac0c30 100644 --- a/python/core/layertree/qgslayertreemodel.sip +++ b/python/core/layertree/qgslayertreemodel.sip @@ -126,9 +126,9 @@ Return index for a given node. If the node does not belong to the layer tree, th QList indexes2nodes( const QModelIndexList &list, bool skipInternal = false ) const; %Docstring - Convert a list of indexes to a list of layer tree nodes. + Convert a ``list`` of indexes to a list of layer tree nodes. Indices that do not represent layer tree nodes are skipped. - \param skipInternal If true, a node is included in the output list only if no parent node is in the list + If ``skipInternal`` is true, a node is included in the output list only if no parent node is in the list. :rtype: list of QgsLayerTreeNode %End diff --git a/python/core/qgspointlocator.sip b/python/core/qgspointlocator.sip index 1dee88f40b7..292b61099c3 100644 --- a/python/core/qgspointlocator.sip +++ b/python/core/qgspointlocator.sip @@ -32,10 +32,12 @@ class QgsPointLocator : QObject explicit QgsPointLocator( QgsVectorLayer *layer, const QgsCoordinateReferenceSystem &destinationCrs = QgsCoordinateReferenceSystem(), const QgsRectangle *extent = 0 ); %Docstring - Construct point locator for a layer. - \param destinationCrs if a valid QgsCoordinateReferenceSystem is passed then the locator will - do the searches on data reprojected to the given CRS - \param extent if not null, will index only a subset of the layer + Construct point locator for a ``layer``. + + If a valid QgsCoordinateReferenceSystem is passed for ``destinationCrs`` then the locator will + do the searches on data reprojected to the given CRS. + + If ``extent`` is not null, the locator will index only a subset of the layer which falls within that extent. %End ~QgsPointLocator(); diff --git a/src/core/layertree/qgslayertreemodel.h b/src/core/layertree/qgslayertreemodel.h index 814e240bf2a..2a3ccfcaeee 100644 --- a/src/core/layertree/qgslayertreemodel.h +++ b/src/core/layertree/qgslayertreemodel.h @@ -127,9 +127,9 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel QModelIndex node2index( QgsLayerTreeNode *node ) const; /** - * Convert a list of indexes to a list of layer tree nodes. + * Convert a \a list of indexes to a list of layer tree nodes. * Indices that do not represent layer tree nodes are skipped. - * \param skipInternal If true, a node is included in the output list only if no parent node is in the list + * If \a skipInternal is true, a node is included in the output list only if no parent node is in the list. */ QList indexes2nodes( const QModelIndexList &list, bool skipInternal = false ) const; diff --git a/src/core/qgspointlocator.h b/src/core/qgspointlocator.h index a92184f45a2..90948989057 100644 --- a/src/core/qgspointlocator.h +++ b/src/core/qgspointlocator.h @@ -51,10 +51,12 @@ class CORE_EXPORT QgsPointLocator : public QObject Q_OBJECT public: - /** Construct point locator for a layer. - * \param destinationCrs if a valid QgsCoordinateReferenceSystem is passed then the locator will - * do the searches on data reprojected to the given CRS - * \param extent if not null, will index only a subset of the layer + /** Construct point locator for a \a layer. + * + * If a valid QgsCoordinateReferenceSystem is passed for \a destinationCrs then the locator will + * do the searches on data reprojected to the given CRS. + * + * If \a extent is not null, the locator will index only a subset of the layer which falls within that extent. */ explicit QgsPointLocator( QgsVectorLayer *layer, const QgsCoordinateReferenceSystem &destinationCrs = QgsCoordinateReferenceSystem(), const QgsRectangle *extent = nullptr ); diff --git a/src/gui/qgsprojectionselectiontreewidget.cpp b/src/gui/qgsprojectionselectiontreewidget.cpp index d11662989e5..7574be330e2 100644 --- a/src/gui/qgsprojectionselectiontreewidget.cpp +++ b/src/gui/qgsprojectionselectiontreewidget.cpp @@ -985,7 +985,7 @@ QStringList QgsProjectionSelectionTreeWidget::authorities() return authorities; } -const QString QgsProjectionSelectionTreeWidget::sqlSafeString( const QString &theSQL ) +QString QgsProjectionSelectionTreeWidget::sqlSafeString( const QString &theSQL ) const { QString retval = theSQL; retval.replace( '\\', QLatin1String( "\\\\" ) ); diff --git a/src/gui/qgsprojectionselectiontreewidget.h b/src/gui/qgsprojectionselectiontreewidget.h index 7d65d7c2fda..9f6e0528fb8 100644 --- a/src/gui/qgsprojectionselectiontreewidget.h +++ b/src/gui/qgsprojectionselectiontreewidget.h @@ -155,15 +155,14 @@ class GUI_EXPORT QgsProjectionSelectionTreeWidget : public QWidget, private Ui:: void loadCrsList( QSet *crsFilter = nullptr ); /** - * \brief Make the string safe for use in SQL statements. + * \brief Makes a \a string safe for use in SQL statements. * This involves escaping single quotes, double quotes, backslashes, * and optionally, percentage symbols. Percentage symbols are used * as wildcards sometimes and so when using the string as part of the * LIKE phrase of a select statement, should be escaped. - * \param const QString in The input string to make safe. * \returns The string made safe for SQL statements. */ - const QString sqlSafeString( const QString &theSQL ); + QString sqlSafeString( const QString &string ) const; /** * \brief converts the CRS group to a SQL expression fragment