Add missing docs

qgis · Sep 11, 2017 · 6166d21 · 6166d21
1 parent 727d209
commit 6166d21
Show file tree

Hide file tree

Showing 36 changed files with 128 additions and 1 deletion.
diff --git a/python/core/fieldformatter/qgsvaluerelationfieldformatter.sip b/python/core/fieldformatter/qgsvaluerelationfieldformatter.sip
@@ -35,6 +35,9 @@ class QgsValueRelationFieldFormatter : QgsFieldFormatter
     typedef QVector < QgsValueRelationFieldFormatter::ValueRelationItem > ValueRelationCache;
 
     QgsValueRelationFieldFormatter();
+%Docstring
+ Constructor for QgsValueRelationFieldFormatter.
+%End
 
     virtual QString id() const;
 

diff --git a/python/core/gps/qgsgpsconnectionregistry.sip b/python/core/gps/qgsgpsconnectionregistry.sip
@@ -25,7 +25,11 @@ class QgsGPSConnectionRegistry
 #include "qgsgpsconnectionregistry.h"
 %End
   public:
+
     QgsGPSConnectionRegistry();
+%Docstring
+ Constructor for QgsGPSConnectionRegistry.
+%End
     ~QgsGPSConnectionRegistry();
 
 

diff --git a/python/core/qgscolorscheme.sip b/python/core/qgscolorscheme.sip
@@ -286,6 +286,9 @@ class QgsProjectColorScheme : QgsColorScheme
   public:
 
     QgsProjectColorScheme();
+%Docstring
+ Constructor for QgsProjectColorScheme.
+%End
 
     virtual QString schemeName() const;
 

diff --git a/python/core/qgscredentials.sip b/python/core/qgscredentials.sip
@@ -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

diff --git a/python/core/qgsdatadefinedsizelegend.sip b/python/core/qgsdatadefinedsizelegend.sip
@@ -25,7 +25,11 @@ class QgsDataDefinedSizeLegend
 #include "qgsdatadefinedsizelegend.h"
 %End
   public:
+
     QgsDataDefinedSizeLegend();
+%Docstring
+ Constructor for QgsDataDefinedSizeLegend.
+%End
 
     QgsDataDefinedSizeLegend( const QgsDataDefinedSizeLegend &other );
 %Docstring

diff --git a/python/core/qgsexpressionfieldbuffer.sip b/python/core/qgsexpressionfieldbuffer.sip
@@ -31,6 +31,9 @@ class QgsExpressionFieldBuffer
     };
 
     QgsExpressionFieldBuffer();
+%Docstring
+ Constructor for QgsExpressionFieldBuffer.
+%End
 
     void addExpression( const QString &exp, const QgsField &fld );
 %Docstring

diff --git a/python/core/qgsgmlschema.sip b/python/core/qgsgmlschema.sip
@@ -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();

diff --git a/python/core/qgslabelsearchtree.sip b/python/core/qgslabelsearchtree.sip
@@ -20,7 +20,11 @@ class QgsLabelSearchTree
 #include "qgslabelsearchtree.h"
 %End
   public:
+
     QgsLabelSearchTree();
+%Docstring
+ Constructor for QgsLabelSearchTree.
+%End
     ~QgsLabelSearchTree();
 
 

diff --git a/python/core/qgsobjectcustomproperties.sip b/python/core/qgsobjectcustomproperties.sip
@@ -23,7 +23,11 @@ class QgsObjectCustomProperties
 #include "qgsobjectcustomproperties.h"
 %End
   public:
+
     QgsObjectCustomProperties();
+%Docstring
+ Constructor for QgsObjectCustomProperties.
+%End
 
     QStringList keys() const;
 %Docstring

diff --git a/python/core/qgspluginlayerregistry.sip b/python/core/qgspluginlayerregistry.sip
@@ -68,6 +68,9 @@ class QgsPluginLayerRegistry
   public:
 
     QgsPluginLayerRegistry();
+%Docstring
+ Constructor for QgsPluginLayerRegistry.
+%End
     ~QgsPluginLayerRegistry();
 
 

diff --git a/python/core/qgspropertycollection.sip b/python/core/qgspropertycollection.sip
@@ -368,6 +368,9 @@ class QgsPropertyCollectionStack : QgsAbstractPropertyCollection
   public:
 
     QgsPropertyCollectionStack();
+%Docstring
+ Constructor for QgsPropertyCollectionStack.
+%End
 
     ~QgsPropertyCollectionStack();
 

diff --git a/python/core/qgstrackedvectorlayertools.sip b/python/core/qgstrackedvectorlayertools.sip
@@ -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;
 

diff --git a/python/core/raster/qgsbilinearrasterresampler.sip b/python/core/raster/qgsbilinearrasterresampler.sip
@@ -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 );
 

diff --git a/python/core/raster/qgsrasterpipe.sip b/python/core/raster/qgsrasterpipe.sip
@@ -34,6 +34,10 @@ class QgsRasterPipe
     };
 
     QgsRasterPipe();
+%Docstring
+ Constructor for QgsRasterPipe.
+%End
+
 
     ~QgsRasterPipe();
 

diff --git a/python/gui/qgssourceselectproviderregistry.sip b/python/gui/qgssourceselectproviderregistry.sip
@@ -30,7 +30,11 @@ class QgsSourceSelectProviderRegistry
 #include "qgssourceselectproviderregistry.h"
 %End
   public:
+
     QgsSourceSelectProviderRegistry();
+%Docstring
+ Constructor for QgsSourceSelectProviderRegistry.
+%End
 
     ~QgsSourceSelectProviderRegistry();
 

diff --git a/python/gui/symbology/qgssymbolwidgetcontext.sip b/python/gui/symbology/qgssymbolwidgetcontext.sip
@@ -26,6 +26,9 @@ class QgsSymbolWidgetContext
   public:
 
     QgsSymbolWidgetContext();
+%Docstring
+ Constructor for QgsSymbolWidgetContext.
+%End
 
     QgsSymbolWidgetContext( const QgsSymbolWidgetContext &other );
 %Docstring

diff --git a/src/core/fieldformatter/qgsvaluerelationfieldformatter.h b/src/core/fieldformatter/qgsvaluerelationfieldformatter.h
@@ -49,6 +49,9 @@ class CORE_EXPORT QgsValueRelationFieldFormatter : public QgsFieldFormatter
 
     typedef QVector < QgsValueRelationFieldFormatter::ValueRelationItem > ValueRelationCache;
 
+    /**
+     * Constructor for QgsValueRelationFieldFormatter.
+     */
     QgsValueRelationFieldFormatter() = default;
 
     QString id() const override;

diff --git a/src/core/geometry/qgsgeos.cpp b/src/core/geometry/qgsgeos.cpp
@@ -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; }

diff --git a/src/core/gps/qgsgpsconnectionregistry.h b/src/core/gps/qgsgpsconnectionregistry.h
@@ -35,6 +35,10 @@ class QgsGPSConnection;
 class CORE_EXPORT QgsGPSConnectionRegistry
 {
   public:
+
+    /**
+     * Constructor for QgsGPSConnectionRegistry.
+     */
     QgsGPSConnectionRegistry() = default;
     ~QgsGPSConnectionRegistry();
 

diff --git a/src/core/qgscolorscheme.h b/src/core/qgscolorscheme.h
@@ -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" ); }

diff --git a/src/core/qgscredentials.h b/src/core/qgscredentials.h
@@ -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() );

diff --git a/src/core/qgsdatadefinedsizelegend.h b/src/core/qgsdatadefinedsizelegend.h
@@ -39,6 +39,10 @@ class QgsSizeScaleTransformer;
 class CORE_EXPORT QgsDataDefinedSizeLegend
 {
   public:
+
+    /**
+     * Constructor for QgsDataDefinedSizeLegend.
+     */
     QgsDataDefinedSizeLegend() = default;
 
     //! Copy constructor

diff --git a/src/core/qgsexpressionfieldbuffer.h b/src/core/qgsexpressionfieldbuffer.h
@@ -45,6 +45,9 @@ class CORE_EXPORT QgsExpressionFieldBuffer
       QgsField field;
     };
 
+    /**
+     * Constructor for QgsExpressionFieldBuffer.
+     */
     QgsExpressionFieldBuffer() = default;
 
     /**

diff --git a/src/core/qgsgmlschema.h b/src/core/qgsgmlschema.h
@@ -39,6 +39,10 @@ class QgsFeature;
 class CORE_EXPORT QgsGmlFeatureClass
 {
   public:
+
+    /**
+     * Constructor for QgsGmlFeatureClass.
+     */
     QgsGmlFeatureClass() = default;
     QgsGmlFeatureClass( const QString &name, const QString &path );
 

diff --git a/src/core/qgslabelsearchtree.h b/src/core/qgslabelsearchtree.h
@@ -36,6 +36,10 @@ class QgsPointXY;
 class CORE_EXPORT QgsLabelSearchTree
 {
   public:
+
+    /**
+     * Constructor for QgsLabelSearchTree.
+     */
     QgsLabelSearchTree() = default;
     ~QgsLabelSearchTree();
 

diff --git a/src/core/qgsobjectcustomproperties.h b/src/core/qgsobjectcustomproperties.h
@@ -34,6 +34,10 @@ class QDomNode;
 class CORE_EXPORT QgsObjectCustomProperties
 {
   public:
+
+    /**
+     * Constructor for QgsObjectCustomProperties.
+     */
     QgsObjectCustomProperties() = default;
 
     //! Return list of stored keys

diff --git a/src/core/qgspluginlayerregistry.h b/src/core/qgspluginlayerregistry.h
@@ -66,6 +66,9 @@ class CORE_EXPORT QgsPluginLayerRegistry
 {
   public:
 
+    /**
+     * Constructor for QgsPluginLayerRegistry.
+     */
     QgsPluginLayerRegistry() = default;
     ~QgsPluginLayerRegistry();
 

diff --git a/src/core/qgspropertycollection.h b/src/core/qgspropertycollection.h
@@ -368,6 +368,9 @@ class CORE_EXPORT QgsPropertyCollectionStack : public QgsAbstractPropertyCollect
 {
   public:
 
+    /**
+     * Constructor for QgsPropertyCollectionStack.
+     */
     QgsPropertyCollectionStack() = default;
 
     ~QgsPropertyCollectionStack();

diff --git a/src/core/qgssqlstatement.cpp b/src/core/qgssqlstatement.cpp
@@ -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;

diff --git a/src/core/qgstrackedvectorlayertools.h b/src/core/qgstrackedvectorlayertools.h
@@ -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;

diff --git a/src/core/raster/qgsbilinearrasterresampler.h b/src/core/raster/qgsbilinearrasterresampler.h
@@ -30,6 +30,10 @@
 class CORE_EXPORT QgsBilinearRasterResampler: public QgsRasterResampler
 {
   public:
+
+    /**
+     * Constructor for QgsBilinearRasterResampler.
+     */
     QgsBilinearRasterResampler() = default;
 
     void resample( const QImage &srcImage, QImage &dstImage ) override;

diff --git a/src/core/raster/qgsrasterpipe.h b/src/core/raster/qgsrasterpipe.h
@@ -58,7 +58,11 @@ class CORE_EXPORT QgsRasterPipe
       HueSaturationRole = 7
     };
 
+    /**
+     * Constructor for QgsRasterPipe.
+     */
     QgsRasterPipe() = default;
+
     QgsRasterPipe( const QgsRasterPipe &pipe ) SIP_SKIP;
 
     ~QgsRasterPipe();

diff --git a/src/gui/qgsmapcanvas.cpp b/src/gui/qgsmapcanvas.cpp
@@ -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

diff --git a/src/gui/qgssourceselectproviderregistry.h b/src/gui/qgssourceselectproviderregistry.h
@@ -37,6 +37,10 @@ class QgsSourceSelectProvider;
 class GUI_EXPORT QgsSourceSelectProviderRegistry
 {
   public:
+
+    /**
+     * Constructor for QgsSourceSelectProviderRegistry.
+     */
     QgsSourceSelectProviderRegistry() = default;
 
     ~QgsSourceSelectProviderRegistry();

diff --git a/src/gui/symbology/qgssymbolwidgetcontext.h b/src/gui/symbology/qgssymbolwidgetcontext.h
@@ -35,6 +35,9 @@ class GUI_EXPORT QgsSymbolWidgetContext // clazy:exclude=rule-of-three
 {
   public:
 
+    /**
+     * Constructor for QgsSymbolWidgetContext.
+     */
     QgsSymbolWidgetContext() = default;
 
     /** Copy constructor.

diff --git a/tests/code_layout/doxygen_parser.py b/tests/code_layout/doxygen_parser.py
@@ -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: