Skip to content
Permalink
Browse files

Fix doxygen warnings

  • Loading branch information
nyalldawson committed Oct 5, 2017
1 parent 49b426d commit 78c0c284687ee89c991d829ae7fc9d13a91ddbe4
@@ -126,9 +126,9 @@ Return index for a given node. If the node does not belong to the layer tree, th

QList<QgsLayerTreeNode *> 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

@@ -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();
@@ -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<QgsLayerTreeNode *> indexes2nodes( const QModelIndexList &list, bool skipInternal = false ) const;

@@ -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 );
@@ -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( "\\\\" ) );
@@ -155,15 +155,14 @@ class GUI_EXPORT QgsProjectionSelectionTreeWidget : public QWidget, private Ui::
void loadCrsList( QSet<QString> *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

0 comments on commit 78c0c28

Please sign in to comment.
You can’t perform that action at this time.