Skip to content
Permalink
Browse files

Fix doc coverage test for "added in XXX" check

  • Loading branch information
wonder-sk committed Aug 1, 2016
1 parent 71ca330 commit 38b63edc46c9db109660d8afdba685b8970a1999
Showing with 9 additions and 7 deletions.
  1. +1 −2 python/core/qgsfeedback.sip
  2. +1 −2 src/core/qgsfeedback.h
  3. +2 −1 src/core/raster/qgsrasterpipe.h
  4. +5 −2 tests/src/python/utilities.py
@@ -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
{
@@ -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
{
@@ -19,9 +19,10 @@
#define QGSRASTERPIPE_H

#include <QImage>
#include <QMap>
#include <QObject>
#include "qgsrasterinterface.h"

class QgsRasterInterface;
class QgsRasterRenderer;
class QgsRasterResampleFilter;
class QgsBrightnessContrastFilter;
@@ -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

1 comment on commit 38b63ed

@nyalldawson

This comment has been minimized.

Copy link
Contributor

@nyalldawson nyalldawson commented on 38b63ed Aug 1, 2016

Thanks!

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