Skip to content
Permalink
Browse files

Add missing docs

  • Loading branch information
nyalldawson committed Sep 11, 2017
1 parent 727d209 commit 6166d21289ce3b818a9aa3f3d485dd8deb2c5941
Showing with 128 additions and 1 deletion.
  1. +3 −0 python/core/fieldformatter/qgsvaluerelationfieldformatter.sip
  2. +4 −0 python/core/gps/qgsgpsconnectionregistry.sip
  3. +3 −0 python/core/qgscolorscheme.sip
  4. +3 −0 python/core/qgscredentials.sip
  5. +4 −0 python/core/qgsdatadefinedsizelegend.sip
  6. +3 −0 python/core/qgsexpressionfieldbuffer.sip
  7. +4 −0 python/core/qgsgmlschema.sip
  8. +4 −0 python/core/qgslabelsearchtree.sip
  9. +4 −0 python/core/qgsobjectcustomproperties.sip
  10. +3 −0 python/core/qgspluginlayerregistry.sip
  11. +3 −0 python/core/qgspropertycollection.sip
  12. +4 −0 python/core/qgstrackedvectorlayertools.sip
  13. +4 −0 python/core/raster/qgsbilinearrasterresampler.sip
  14. +4 −0 python/core/raster/qgsrasterpipe.sip
  15. +4 −0 python/gui/qgssourceselectproviderregistry.sip
  16. +3 −0 python/gui/symbology/qgssymbolwidgetcontext.sip
  17. +3 −0 src/core/fieldformatter/qgsvaluerelationfieldformatter.h
  18. +6 −0 src/core/geometry/qgsgeos.cpp
  19. +4 −0 src/core/gps/qgsgpsconnectionregistry.h
  20. +3 −0 src/core/qgscolorscheme.h
  21. +3 −0 src/core/qgscredentials.h
  22. +4 −0 src/core/qgsdatadefinedsizelegend.h
  23. +3 −0 src/core/qgsexpressionfieldbuffer.h
  24. +4 −0 src/core/qgsgmlschema.h
  25. +4 −0 src/core/qgslabelsearchtree.h
  26. +4 −0 src/core/qgsobjectcustomproperties.h
  27. +3 −0 src/core/qgspluginlayerregistry.h
  28. +3 −0 src/core/qgspropertycollection.h
  29. +3 −0 src/core/qgssqlstatement.cpp
  30. +4 −0 src/core/qgstrackedvectorlayertools.h
  31. +4 −0 src/core/raster/qgsbilinearrasterresampler.h
  32. +4 −0 src/core/raster/qgsrasterpipe.h
  33. +4 −0 src/gui/qgsmapcanvas.cpp
  34. +4 −0 src/gui/qgssourceselectproviderregistry.h
  35. +3 −0 src/gui/symbology/qgssymbolwidgetcontext.h
  36. +1 −1 tests/code_layout/doxygen_parser.py
@@ -35,6 +35,9 @@ class QgsValueRelationFieldFormatter : QgsFieldFormatter
typedef QVector < QgsValueRelationFieldFormatter::ValueRelationItem > ValueRelationCache;

QgsValueRelationFieldFormatter();
%Docstring
Constructor for QgsValueRelationFieldFormatter.
%End

virtual QString id() const;

@@ -25,7 +25,11 @@ class QgsGPSConnectionRegistry
#include "qgsgpsconnectionregistry.h"
%End
public:

QgsGPSConnectionRegistry();
%Docstring
Constructor for QgsGPSConnectionRegistry.
%End
~QgsGPSConnectionRegistry();


@@ -286,6 +286,9 @@ class QgsProjectColorScheme : QgsColorScheme
public:

QgsProjectColorScheme();
%Docstring
Constructor for QgsProjectColorScheme.
%End

virtual QString schemeName() const;

@@ -30,6 +30,9 @@ class QgsCredentials
public:

virtual ~QgsCredentials();
%Docstring
Destructor.
%End

bool get( const QString &realm, QString &username /In,Out/, QString &password /In,Out/, const QString &message = QString() );
%Docstring
@@ -25,7 +25,11 @@ class QgsDataDefinedSizeLegend
#include "qgsdatadefinedsizelegend.h"
%End
public:

QgsDataDefinedSizeLegend();
%Docstring
Constructor for QgsDataDefinedSizeLegend.
%End

QgsDataDefinedSizeLegend( const QgsDataDefinedSizeLegend &other );
%Docstring
@@ -31,6 +31,9 @@ class QgsExpressionFieldBuffer
};

QgsExpressionFieldBuffer();
%Docstring
Constructor for QgsExpressionFieldBuffer.
%End

void addExpression( const QString &exp, const QgsField &fld );
%Docstring
@@ -18,7 +18,11 @@ class QgsGmlFeatureClass
#include "qgsgmlschema.h"
%End
public:

QgsGmlFeatureClass();
%Docstring
Constructor for QgsGmlFeatureClass.
%End
QgsGmlFeatureClass( const QString &name, const QString &path );

QList<QgsField> &fields();
@@ -20,7 +20,11 @@ class QgsLabelSearchTree
#include "qgslabelsearchtree.h"
%End
public:

QgsLabelSearchTree();
%Docstring
Constructor for QgsLabelSearchTree.
%End
~QgsLabelSearchTree();


@@ -23,7 +23,11 @@ class QgsObjectCustomProperties
#include "qgsobjectcustomproperties.h"
%End
public:

QgsObjectCustomProperties();
%Docstring
Constructor for QgsObjectCustomProperties.
%End

QStringList keys() const;
%Docstring
@@ -68,6 +68,9 @@ class QgsPluginLayerRegistry
public:

QgsPluginLayerRegistry();
%Docstring
Constructor for QgsPluginLayerRegistry.
%End
~QgsPluginLayerRegistry();


@@ -368,6 +368,9 @@ class QgsPropertyCollectionStack : QgsAbstractPropertyCollection
public:

QgsPropertyCollectionStack();
%Docstring
Constructor for QgsPropertyCollectionStack.
%End

~QgsPropertyCollectionStack();

@@ -14,7 +14,11 @@ class QgsTrackedVectorLayerTools : QgsVectorLayerTools
#include "qgstrackedvectorlayertools.h"
%End
public:

QgsTrackedVectorLayerTools();
%Docstring
Constructor for QgsTrackedVectorLayerTools.
%End

virtual bool addFeature( QgsVectorLayer *layer, const QgsAttributeMap &defaultValues, const QgsGeometry &defaultGeometry, QgsFeature *feature ) const;

@@ -20,7 +20,11 @@ Bilinear Raster Resampler
#include "qgsbilinearrasterresampler.h"
%End
public:

QgsBilinearRasterResampler();
%Docstring
Constructor for QgsBilinearRasterResampler.
%End

virtual void resample( const QImage &srcImage, QImage &dstImage );

@@ -34,6 +34,10 @@ class QgsRasterPipe
};

QgsRasterPipe();
%Docstring
Constructor for QgsRasterPipe.
%End


~QgsRasterPipe();

@@ -30,7 +30,11 @@ class QgsSourceSelectProviderRegistry
#include "qgssourceselectproviderregistry.h"
%End
public:

QgsSourceSelectProviderRegistry();
%Docstring
Constructor for QgsSourceSelectProviderRegistry.
%End

~QgsSourceSelectProviderRegistry();

@@ -26,6 +26,9 @@ class QgsSymbolWidgetContext
public:

QgsSymbolWidgetContext();
%Docstring
Constructor for QgsSymbolWidgetContext.
%End

QgsSymbolWidgetContext( const QgsSymbolWidgetContext &other );
%Docstring
@@ -49,6 +49,9 @@ class CORE_EXPORT QgsValueRelationFieldFormatter : public QgsFieldFormatter

typedef QVector < QgsValueRelationFieldFormatter::ValueRelationItem > ValueRelationCache;

/**
* Constructor for QgsValueRelationFieldFormatter.
*/
QgsValueRelationFieldFormatter() = default;

QString id() const override;
@@ -111,10 +111,16 @@ static GEOSInit geosinit;
class GEOSGeomScopedPtr
{
public:

/**
* Constructor for GEOSGeomScopedPtr, owning the specified \a geom.
*/
explicit GEOSGeomScopedPtr( GEOSGeometry *geom = nullptr ) : mGeom( geom ) {}
~GEOSGeomScopedPtr() { GEOSGeom_destroy_r( geosinit.ctxt, mGeom ); }

//! GEOSGeomScopedPtr cannot be copied
GEOSGeomScopedPtr( const GEOSGeomScopedPtr &rh ) = delete;
//! GEOSGeomScopedPtr cannot be copied
GEOSGeomScopedPtr &operator=( const GEOSGeomScopedPtr &rh ) = delete;

GEOSGeometry *get() const { return mGeom; }
@@ -35,6 +35,10 @@ class QgsGPSConnection;
class CORE_EXPORT QgsGPSConnectionRegistry
{
public:

/**
* Constructor for QgsGPSConnectionRegistry.
*/
QgsGPSConnectionRegistry() = default;
~QgsGPSConnectionRegistry();

@@ -268,6 +268,9 @@ class CORE_EXPORT QgsProjectColorScheme : public QgsColorScheme
{
public:

/**
* Constructor for QgsProjectColorScheme.
*/
QgsProjectColorScheme() = default;

virtual QString schemeName() const override { return QObject::tr( "Project colors" ); }
@@ -41,6 +41,9 @@ class CORE_EXPORT QgsCredentials
{
public:

/**
* Destructor.
*/
virtual ~QgsCredentials() = default;

bool get( const QString &realm, QString &username SIP_INOUT, QString &password SIP_INOUT, const QString &message = QString() );
@@ -39,6 +39,10 @@ class QgsSizeScaleTransformer;
class CORE_EXPORT QgsDataDefinedSizeLegend
{
public:

/**
* Constructor for QgsDataDefinedSizeLegend.
*/
QgsDataDefinedSizeLegend() = default;

//! Copy constructor
@@ -45,6 +45,9 @@ class CORE_EXPORT QgsExpressionFieldBuffer
QgsField field;
};

/**
* Constructor for QgsExpressionFieldBuffer.
*/
QgsExpressionFieldBuffer() = default;

/**
@@ -39,6 +39,10 @@ class QgsFeature;
class CORE_EXPORT QgsGmlFeatureClass
{
public:

/**
* Constructor for QgsGmlFeatureClass.
*/
QgsGmlFeatureClass() = default;
QgsGmlFeatureClass( const QString &name, const QString &path );

@@ -36,6 +36,10 @@ class QgsPointXY;
class CORE_EXPORT QgsLabelSearchTree
{
public:

/**
* Constructor for QgsLabelSearchTree.
*/
QgsLabelSearchTree() = default;
~QgsLabelSearchTree();

@@ -34,6 +34,10 @@ class QDomNode;
class CORE_EXPORT QgsObjectCustomProperties
{
public:

/**
* Constructor for QgsObjectCustomProperties.
*/
QgsObjectCustomProperties() = default;

//! Return list of stored keys
@@ -66,6 +66,9 @@ class CORE_EXPORT QgsPluginLayerRegistry
{
public:

/**
* Constructor for QgsPluginLayerRegistry.
*/
QgsPluginLayerRegistry() = default;
~QgsPluginLayerRegistry();

@@ -368,6 +368,9 @@ class CORE_EXPORT QgsPropertyCollectionStack : public QgsAbstractPropertyCollect
{
public:

/**
* Constructor for QgsPropertyCollectionStack.
*/
QgsPropertyCollectionStack() = default;

~QgsPropertyCollectionStack();
@@ -198,6 +198,9 @@ class QgsSQLStatementCollectTableNames: public QgsSQLStatement::RecursiveVisitor
public:
typedef QPair<QString, QString> TableColumnPair;

/**
* Constructor for QgsSQLStatementCollectTableNames.
*/
QgsSQLStatementCollectTableNames() = default;

void visit( const QgsSQLStatement::NodeColumnRef &n ) override;
@@ -26,6 +26,10 @@ class CORE_EXPORT QgsTrackedVectorLayerTools : public QgsVectorLayerTools
{
Q_OBJECT
public:

/**
* Constructor for QgsTrackedVectorLayerTools.
*/
QgsTrackedVectorLayerTools() = default;

bool addFeature( QgsVectorLayer *layer, const QgsAttributeMap &defaultValues, const QgsGeometry &defaultGeometry, QgsFeature *feature ) const override;
@@ -30,6 +30,10 @@
class CORE_EXPORT QgsBilinearRasterResampler: public QgsRasterResampler
{
public:

/**
* Constructor for QgsBilinearRasterResampler.
*/
QgsBilinearRasterResampler() = default;

void resample( const QImage &srcImage, QImage &dstImage ) override;
@@ -58,7 +58,11 @@ class CORE_EXPORT QgsRasterPipe
HueSaturationRole = 7
};

/**
* Constructor for QgsRasterPipe.
*/
QgsRasterPipe() = default;

QgsRasterPipe( const QgsRasterPipe &pipe ) SIP_SKIP;

~QgsRasterPipe();
@@ -76,6 +76,10 @@ email : sherman at mrcc.com
class QgsMapCanvas::CanvasProperties
{
public:

/**
* Constructor for CanvasProperties.
*/
CanvasProperties() = default;

//!Flag to indicate status of mouse button
@@ -37,6 +37,10 @@ class QgsSourceSelectProvider;
class GUI_EXPORT QgsSourceSelectProviderRegistry
{
public:

/**
* Constructor for QgsSourceSelectProviderRegistry.
*/
QgsSourceSelectProviderRegistry() = default;

~QgsSourceSelectProviderRegistry();
@@ -35,6 +35,9 @@ class GUI_EXPORT QgsSymbolWidgetContext // clazy:exclude=rule-of-three
{
public:

/**
* Constructor for QgsSymbolWidgetContext.
*/
QgsSymbolWidgetContext() = default;

/** Copy constructor.
@@ -264,7 +264,7 @@ def memberSignature(self, elem):
signature = elem.find('name').text + a.text
else:
signature = elem.find('name').text
if signature.endsWith('= default'):
if signature.endswith('= default'):
signature = signature[:-len('= default')]
return signature
except:

0 comments on commit 6166d21

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