sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-14 00:07:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix doxygen warnings

Browse Source
This commit is contained in:
Nyall Dawson 2017-10-05 13:40:11 +10:00
parent 49b426d951
commit 78c0c28468
6 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
python/core/layertree/qgslayertreemodel.sip
View File

@ -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

10
python/core/qgspointlocator.sip
View File

@ -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();

4
src/core/layertree/qgslayertreemodel.h
View File

@ -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;

10
src/core/qgspointlocator.h
View File

@ -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 );

2
src/gui/qgsprojectionselectiontreewidget.cpp
View File

@ -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( "\\\\" ) );

5
src/gui/qgsprojectionselectiontreewidget.h
View File

@ -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