Fix doc coverage test for "added in XXX" check

qgis · Aug 1, 2016 · 38b63ed · 38b63ed · nyalldawson · Aug 1, 2016
1 parent 71ca330
commit 38b63ed
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/python/core/qgsfeedback.sip b/python/core/qgsfeedback.sip
@@ -1,8 +1,6 @@
 
 /** \ingroup core
- * @note added in QGIS 3.0
  * Base class for feedback objects to be used for cancellation of something running in a worker thread.
- *
  * The class may be used as is or it may be subclassed for extended functionality
  * for a particular operation (e.g. report progress or pass some data for preview).
  *
@@ -18,6 +16,7 @@
  * subclass and available with QgsMapLayerRenderer::feedback() method. When a map rendering job
  * gets cancelled, the cancel() method is called on the feedback object of all layers.
  *
+ * @note added in QGIS 3.0
  */
 class QgsFeedback : QObject
 {

diff --git a/src/core/qgsfeedback.h b/src/core/qgsfeedback.h
@@ -19,9 +19,7 @@
 #include <QObject>
 
 /** \ingroup core
- * @note added in QGIS 3.0
  * Base class for feedback objects to be used for cancellation of something running in a worker thread.
- *
  * The class may be used as is or it may be subclassed for extended functionality
  * for a particular operation (e.g. report progress or pass some data for preview).
  *
@@ -37,6 +35,7 @@
  * subclass and available with QgsMapLayerRenderer::feedback() method. When a map rendering job
  * gets cancelled, the cancel() method is called on the feedback object of all layers.
  *
+ * @note added in QGIS 3.0
  */
 class CORE_EXPORT QgsFeedback : public QObject
 {

diff --git a/src/core/raster/qgsrasterpipe.h b/src/core/raster/qgsrasterpipe.h
@@ -19,9 +19,10 @@
 #define QGSRASTERPIPE_H
 
 #include <QImage>
+#include <QMap>
 #include <QObject>
-#include "qgsrasterinterface.h"
 
+class QgsRasterInterface;
 class QgsRasterRenderer;
 class QgsRasterResampleFilter;
 class QgsBrightnessContrastFilter;

diff --git a/tests/src/python/utilities.py b/tests/src/python/utilities.py
@@ -545,12 +545,15 @@ def parseClassElem(self, e):
         # test for "added in QGIS xxx" string
         d = e.find('detaileddescription')
         found_version_added = False
-        if d.find('para'):
-            for s in d.find('para').getiterator('simplesect'):
+        for para in d.getiterator('para'):
+            for s in para.getiterator('simplesect'):
                 if s.get('kind') == 'note':
                     for p in s.getiterator('para'):
                         if p.text and p.text.lower().startswith('added in'):
                             found_version_added = True
+                            break
+            if found_version_added:
+                break
 
         return documentable_members, documented_members, undocumented_members, bindable_members, has_brief_description, found_version_added