Add missing doc

This commit is contained in:
Matthias Kuhn 2017-10-25 02:05:10 +02:00
parent ca5cd88272
commit ad7b2d03b0
3 changed files with 11 additions and 8 deletions

View File

@ -72,9 +72,7 @@ end of iterating: free the resources / lock
If you want to check if the iterator successfully completed, better use QgsFeatureIterator.isClosed().
.. note::
Added in QGIS 3.0
.. versionadded:: 3.0
:rtype: bool
%End
@ -257,9 +255,7 @@ destructor deletes the iterator if it has no more references
.. seealso:: isClosed to check if the iterator successfully completed and returned all the features.
.. note::
Added in QGIS 3.0
.. versionadded:: 3.0
:rtype: bool
%End

View File

@ -85,6 +85,13 @@ class QgsConnectionPoolGroup
//! QgsConnectionPoolGroup cannot be copied
QgsConnectionPoolGroup &operator=( const QgsConnectionPoolGroup &other ) = delete;
/**
* Try to acquire a connection for a maximum of \a timeout milliseconds.
* If \a timeout is a negative value the calling thread will be blocked
* until a connection becomes available. This is the default behavior.
*
* \returns initialized connection or nullptr if unsuccessful
*/
T acquire( int timeout )
{
// we are going to acquire a resource - if no resource is available, we will block here

View File

@ -90,7 +90,7 @@ class CORE_EXPORT QgsAbstractFeatureIterator
*
* If you want to check if the iterator successfully completed, better use QgsFeatureIterator::isClosed().
*
* @note Added in QGIS 3.0
* \since QGIS 3.0
*/
virtual bool isValid() const
{
@ -311,7 +311,7 @@ class CORE_EXPORT QgsFeatureIterator
*
* \see isClosed to check if the iterator successfully completed and returned all the features.
*
* @note Added in QGIS 3.0
* \since QGIS 3.0
*/
virtual bool isValid() const;