Fix doxygen

qgis · Sep 6, 2019 · 1191065 · 1191065
1 parent fb7e2c8
commit 1191065
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 4 deletions.
diff --git a/python/core/auto_generated/qgspointlocator.sip.in b/python/core/auto_generated/qgspointlocator.sip.in
@@ -42,9 +42,9 @@ do the searches on data reprojected to the given CRS. For accurate reprojection
 to set the correct ``transformContext`` if a ``destinationCrs`` is specified. This is usually taken
 from the current :py:func:`QgsProject.transformContext()`
 
-:param asynchronous: if ``False``, point locator init() method will block until point locator index
-                     is completely built. if ``True``, index building will be done in another thread and init() method returns
-                     immediately. initFinished() signal will be emitted once the initialization is over.
+if ``asynchronous`` is ``False``, point locator init() method will block until point locator index
+is completely built. if ``True``, index building will be done in another thread and init() method returns
+immediately. initFinished() signal will be emitted once the initialization is over.
 
 If ``extent`` is not ``None``, the locator will index only a subset of the layer which falls within that extent.
 %End

diff --git a/src/core/qgspointlocator.h b/src/core/qgspointlocator.h
@@ -68,7 +68,7 @@ class CORE_EXPORT QgsPointLocator : public QObject
      * to set the correct \a transformContext if a \a destinationCrs is specified. This is usually taken
      * from the current QgsProject::transformContext().
      *
-     * \param asynchronous if FALSE, point locator init() method will block until point locator index
+     * if \a asynchronous is FALSE, point locator init() method will block until point locator index
      * is completely built. if TRUE, index building will be done in another thread and init() method returns
      * immediately. initFinished() signal will be emitted once the initialization is over.
      *

diff --git a/src/core/qgspointlocatorinittask.cpp b/src/core/qgspointlocatorinittask.cpp
@@ -17,6 +17,8 @@
 
 #include "qgsvectorlayer.h"
 
+/// @cond PRIVATE
+
 QgsPointLocatorInitTask::QgsPointLocatorInitTask( QgsPointLocator *loc )
   : QgsTask( tr( "Indexing %1" ).arg( loc->layer()->id() ), QgsTask::Flags() )
   , mLoc( loc )
@@ -28,3 +30,5 @@ bool QgsPointLocatorInitTask::run()
   emit rebuildIndexFinished( ok );
   return true;
 }
+
+/// @endcond
diff --git a/src/core/qgspointlocatorinittask.h b/src/core/qgspointlocatorinittask.h
@@ -51,4 +51,6 @@ class QgsPointLocatorInitTask : public QgsTask
     QgsPointLocator *mLoc = nullptr;
 };
 
+/// @endcond
+
 #endif // QGSPOINTLOCATORINITTASK_H