Add missing docs

qgis · Jan 2, 2017 · a05096d · a05096d
1 parent a4838e1
commit a05096d
Show file tree

Hide file tree

Showing 40 changed files with 86 additions and 0 deletions.
diff --git a/src/analysis/openstreetmap/qgsosmdatabase.h b/src/analysis/openstreetmap/qgsosmdatabase.h
@@ -49,7 +49,9 @@ class ANALYSIS_EXPORT QgsOSMDatabase
     explicit QgsOSMDatabase( const QString& dbFileName = QString() );
     ~QgsOSMDatabase();
 
+    //! QgsOSMDatabase cannot be copied.
     QgsOSMDatabase( const QgsOSMDatabase& rh ) = delete;
+    //! QgsOSMDatabase cannot be copied.
     QgsOSMDatabase& operator=( const QgsOSMDatabase& rh ) = delete;
 
     void setFileName( const QString& dbFileName ) { mDbFileName = dbFileName; }

diff --git a/src/analysis/raster/qgsrastercalcnode.h b/src/analysis/raster/qgsrastercalcnode.h
@@ -76,7 +76,9 @@ class ANALYSIS_EXPORT QgsRasterCalcNode
     QgsRasterCalcNode( const QString& rasterName );
     ~QgsRasterCalcNode();
 
+    //! QgsRasterCalcNode cannot be copied
     QgsRasterCalcNode( const QgsRasterCalcNode& rh ) = delete;
+    //! QgsRasterCalcNode cannot be copied
     QgsRasterCalcNode& operator=( const QgsRasterCalcNode& rh ) = delete;
 
     Type type() const { return mType; }

diff --git a/src/analysis/raster/qgsrelief.h b/src/analysis/raster/qgsrelief.h
@@ -45,7 +45,9 @@ class ANALYSIS_EXPORT QgsRelief
     QgsRelief( const QString& inputFile, const QString& outputFile, const QString& outputFormat );
     ~QgsRelief();
 
+    //! QgsRelief cannot be copied
     QgsRelief( const QgsRelief& rh ) = delete;
+    //! QgsRelief cannot be copied
     QgsRelief& operator=( const QgsRelief& rh ) = delete;
 
     /** Starts the calculation, reads from mInputFile and stores the result in mOutputFile

diff --git a/src/core/effects/qgspainteffectregistry.h b/src/core/effects/qgspainteffectregistry.h
@@ -161,7 +161,9 @@ class CORE_EXPORT QgsPaintEffectRegistry
     QgsPaintEffectRegistry();
     ~QgsPaintEffectRegistry();
 
+    //! QgsPaintEffectRegistry cannot be copied.
     QgsPaintEffectRegistry( const QgsPaintEffectRegistry& rh ) = delete;
+    //! QgsPaintEffectRegistry cannot be copied.
     QgsPaintEffectRegistry& operator=( const QgsPaintEffectRegistry& rh ) = delete;
 
     /** Returns the metadata for a specific effect.

diff --git a/src/core/gps/qgsgpsconnectionregistry.h b/src/core/gps/qgsgpsconnectionregistry.h
@@ -36,7 +36,9 @@ class CORE_EXPORT QgsGPSConnectionRegistry
     QgsGPSConnectionRegistry();
     ~QgsGPSConnectionRegistry();
 
+    //! QgsGPSConnectionRegistry cannot be copied.
     QgsGPSConnectionRegistry( const QgsGPSConnectionRegistry& rh ) = delete;
+    //! QgsGPSConnectionRegistry cannot be copied.
     QgsGPSConnectionRegistry& operator=( const QgsGPSConnectionRegistry& rh ) = delete;
 
     //! Inserts a connection into the registry. The connection is owned by the registry class until it is unregistered again

diff --git a/src/core/pal/feature.h b/src/core/pal/feature.h
@@ -66,7 +66,9 @@ namespace pal
       }
       ~LabelInfo() { delete [] char_info; }
 
+      //! LabelInfo cannot be copied
       LabelInfo( const LabelInfo& rh ) = delete;
+      //! LabelInfo cannot be copied
       LabelInfo& operator=( const LabelInfo& rh ) = delete;
 
       double max_char_angle_inside;

diff --git a/src/core/pal/pal.h b/src/core/pal/pal.h
@@ -96,7 +96,9 @@ namespace pal
 
       ~Pal();
 
+      //! Pal cannot be copied.
       Pal( const Pal& other ) = delete;
+      //! Pal cannot be copied.
       Pal& operator=( const Pal& other ) = delete;
 
       /**

diff --git a/src/core/pal/palstat.h b/src/core/pal/palstat.h
@@ -51,7 +51,9 @@ namespace pal
 
       ~PalStat();
 
+      //! PalStat cannot be copied
       PalStat( const PalStat& other ) = delete;
+      //! PalStat cannot be copied
       PalStat& operator=( const PalStat& other ) = delete;
 
       /**

diff --git a/src/core/pal/priorityqueue.h b/src/core/pal/priorityqueue.h
@@ -58,7 +58,9 @@ namespace pal
       PriorityQueue( int n, int maxId, bool min );
       ~PriorityQueue();
 
+      //! PriorityQueue cannot be copied.
       PriorityQueue( const PriorityQueue & ) = delete;
+      //! PriorityQueue cannot be copied.
       PriorityQueue &operator=( const PriorityQueue & ) = delete;
 
       void print();

diff --git a/src/core/pal/problem.h b/src/core/pal/problem.h
@@ -112,7 +112,9 @@ namespace pal
 
       ~Problem();
 
+      //! Problem cannot be copied
       Problem( const Problem& other ) = delete;
+      //! Problem cannot be copied
       Problem& operator=( const Problem& other ) = delete;
 
       /** Adds a candidate label position to the problem.

diff --git a/src/core/qgsconnectionpool.h b/src/core/qgsconnectionpool.h
@@ -78,7 +78,9 @@ class QgsConnectionPoolGroup
       }
     }
 
+    //! QgsConnectionPoolGroup cannot be copied
     QgsConnectionPoolGroup( const QgsConnectionPoolGroup& other ) = delete;
+    //! QgsConnectionPoolGroup cannot be copied
     QgsConnectionPoolGroup& operator=( const QgsConnectionPoolGroup& other ) = delete;
 
     T acquire()

diff --git a/src/core/qgscrscache.h b/src/core/qgscrscache.h
@@ -32,7 +32,9 @@ class CORE_EXPORT QgsCoordinateTransformCache
   public:
     static QgsCoordinateTransformCache* instance();
 
+    //! QgsCoordinateTransformCache cannot be copied
     QgsCoordinateTransformCache( const QgsCoordinateTransformCache& rh ) = delete;
+    //! QgsCoordinateTransformCache cannot be copied
     QgsCoordinateTransformCache& operator=( const QgsCoordinateTransformCache& rh ) = delete;
 
     /** Returns coordinate transformation. Cache keeps ownership

diff --git a/src/core/qgsdataitemproviderregistry.h b/src/core/qgsdataitemproviderregistry.h
@@ -37,7 +37,9 @@ class CORE_EXPORT QgsDataItemProviderRegistry
 
     ~QgsDataItemProviderRegistry();
 
+    //! QgsDataItemProviderRegistry cannot be copied.
     QgsDataItemProviderRegistry( const QgsDataItemProviderRegistry& rh ) = delete;
+    //! QgsDataItemProviderRegistry cannot be copied.
     QgsDataItemProviderRegistry& operator=( const QgsDataItemProviderRegistry& rh ) = delete;
 
     //! Get list of available providers

diff --git a/src/core/qgsexpression.h b/src/core/qgsexpression.h
@@ -1187,7 +1187,9 @@ class CORE_EXPORT QgsExpression
         {}
         ~WhenThen() { delete mWhenExp; delete mThenExp; }
 
+        //! WhenThen nodes cannot be copied.
         WhenThen( const WhenThen& rh ) = delete;
+        //! WhenThen nodes cannot be copied.
         WhenThen& operator=( const WhenThen& rh ) = delete;
 
         // protected:

diff --git a/src/core/qgsgml.h b/src/core/qgsgml.h
@@ -88,7 +88,9 @@ class CORE_EXPORT QgsGmlStreamingParser
                            bool invertAxisOrientation = false );
     ~QgsGmlStreamingParser();
 
+    //! QgsGmlStreamingParser cannot be copied.
     QgsGmlStreamingParser( const QgsGmlStreamingParser& other ) = delete;
+    //! QgsGmlStreamingParser cannot be copied.
     QgsGmlStreamingParser& operator=( const QgsGmlStreamingParser& other ) = delete;
 
     /** Process a new chunk of data. atEnd must be set to true when this is

diff --git a/src/core/qgslabelingengine.h b/src/core/qgslabelingengine.h
@@ -165,7 +165,9 @@ class CORE_EXPORT QgsLabelingEngine
     //! Clean up everything (especially the registered providers)
     ~QgsLabelingEngine();
 
+    //! QgsLabelingEngine cannot be copied.
     QgsLabelingEngine( const QgsLabelingEngine& rh ) = delete;
+    //! QgsLabelingEngine cannot be copied.
     QgsLabelingEngine& operator=( const QgsLabelingEngine& rh ) = delete;
 
     enum Flag

diff --git a/src/core/qgslabelsearchtree.h b/src/core/qgslabelsearchtree.h
@@ -36,7 +36,9 @@ class CORE_EXPORT QgsLabelSearchTree
     QgsLabelSearchTree();
     ~QgsLabelSearchTree();
 
+    //! QgsLabelSearchTree cannot be copied.
     QgsLabelSearchTree( const QgsLabelSearchTree& rh ) = delete;
+    //! QgsLabelSearchTree cannot be copied.
     QgsLabelSearchTree& operator=( const QgsLabelSearchTree& rh ) = delete;
 
     //! Removes and deletes all the entries

diff --git a/src/core/qgslocalec.h b/src/core/qgslocalec.h
@@ -31,7 +31,9 @@ class CORE_EXPORT QgsLocaleNumC
     QgsLocaleNumC();
     ~QgsLocaleNumC();
 
+    //! QgsLocaleNumC cannot be copied
     QgsLocaleNumC( const QgsLocaleNumC& rh ) = delete;
+    //! QgsLocaleNumC cannot be copied
     QgsLocaleNumC& operator=( const QgsLocaleNumC& rh ) = delete;
 
 };

diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h
@@ -71,7 +71,9 @@ class CORE_EXPORT QgsMapLayer : public QObject
 
     virtual ~QgsMapLayer();
 
+    //! QgsMapLayer cannot be copied
     QgsMapLayer( QgsMapLayer const & ) = delete;
+    //! QgsMapLayer cannot be copied
     QgsMapLayer & operator=( QgsMapLayer const & ) = delete;
 
     /** Returns the type of the layer.

diff --git a/src/core/qgspallabeling.h b/src/core/qgspallabeling.h
@@ -705,7 +705,9 @@ class CORE_EXPORT QgsLabelingResults
     QgsLabelingResults();
     ~QgsLabelingResults();
 
+    //! QgsLabelingResults cannot be copied.
     QgsLabelingResults( const QgsLabelingResults& ) = delete;
+    //! QgsLabelingResults cannot be copied.
     QgsLabelingResults& operator=( const QgsLabelingResults& rh ) = delete;
 
     //! return infos about labels at a given (map) position

diff --git a/src/core/qgspluginlayerregistry.h b/src/core/qgspluginlayerregistry.h
@@ -66,7 +66,9 @@ class CORE_EXPORT QgsPluginLayerRegistry
     QgsPluginLayerRegistry();
     ~QgsPluginLayerRegistry();
 
+    //! QgsPluginLayerRegistry cannot be copied.
     QgsPluginLayerRegistry( const QgsPluginLayerRegistry& rh ) = delete;
+    //! QgsPluginLayerRegistry cannot be copied.
     QgsPluginLayerRegistry& operator=( const QgsPluginLayerRegistry& rh ) = delete;
 
     /** List all known layer types

diff --git a/src/core/qgsrulebasedlabeling.h b/src/core/qgsrulebasedlabeling.h
@@ -57,7 +57,9 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling
         Rule( QgsPalLayerSettings* settings, int scaleMinDenom = 0, int scaleMaxDenom = 0, const QString& filterExp = QString(), const QString& description = QString(), bool elseRule = false );
         ~Rule();
 
+        //! Rules cannot be copied.
         Rule( const Rule& rh ) = delete;
+        //! Rules cannot be copied.
         Rule& operator=( const Rule& rh ) = delete;
 
         //! The result of registering a rule

diff --git a/src/core/qgstransaction.h b/src/core/qgstransaction.h
@@ -52,7 +52,9 @@ class CORE_EXPORT QgsTransaction : public QObject
 
   public:
 
+    //! QgsTransaction cannot be copied.
     QgsTransaction( const QgsTransaction& other ) = delete;
+    //! QgsTransaction cannot be copied.
     const QgsTransaction& operator=( const QgsTransaction& other ) = delete;
 
     //! Creates a transaction for the specified connection string and provider

diff --git a/src/core/qgsvectorfilewriter.h b/src/core/qgsvectorfilewriter.h
@@ -419,7 +419,9 @@ class CORE_EXPORT QgsVectorFileWriter
                          SymbologyExport symbologyExport = NoSymbology
                        );
 
+    //! QgsVectorFileWriter cannot be copied.
     QgsVectorFileWriter( const QgsVectorFileWriter& rh ) = delete;
+    //! QgsVectorFileWriter cannot be copied.
     QgsVectorFileWriter& operator=( const QgsVectorFileWriter& rh ) = delete;
 
     //! Returns map with format filter string as key and OGR format key as value

diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h
@@ -457,7 +457,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
 
     virtual ~QgsVectorLayer();
 
+    //! QgsVectorLayer cannot be copied.
     QgsVectorLayer( const QgsVectorLayer & rhs ) = delete;
+    //! QgsVectorLayer cannot be copied.
     QgsVectorLayer & operator=( QgsVectorLayer const & rhs ) = delete;
 
     //! Returns the permanent storage type for this layer as a friendly name.

diff --git a/src/core/qgsvectorlayerimport.h b/src/core/qgsvectorlayerimport.h
@@ -99,7 +99,9 @@ class CORE_EXPORT QgsVectorLayerImport
                           QProgressDialog *progress = nullptr
                         );
 
+    //! QgsVectorLayerImport cannot be copied
     QgsVectorLayerImport( const QgsVectorLayerImport& rh ) = delete;
+    //! QgsVectorLayerImport cannot be copied
     QgsVectorLayerImport& operator=( const QgsVectorLayerImport& rh ) = delete;
 
     //! Checks whether there were any errors

diff --git a/src/core/raster/qgsmultibandcolorrenderer.h b/src/core/raster/qgsmultibandcolorrenderer.h
@@ -34,7 +34,9 @@ class CORE_EXPORT QgsMultiBandColorRenderer: public QgsRasterRenderer
                                QgsContrastEnhancement* blueEnhancement = nullptr );
     ~QgsMultiBandColorRenderer();
 
+    //! QgsMultiBandColorRenderer cannot be copied. Use clone() instead.
     QgsMultiBandColorRenderer( const QgsMultiBandColorRenderer& ) = delete;
+    //! QgsMultiBandColorRenderer cannot be copied. Use clone() instead.
     const QgsMultiBandColorRenderer& operator=( const QgsMultiBandColorRenderer& ) = delete;
 
     QgsMultiBandColorRenderer * clone() const override;

diff --git a/src/core/raster/qgspalettedrasterrenderer.h b/src/core/raster/qgspalettedrasterrenderer.h
@@ -37,7 +37,9 @@ class CORE_EXPORT QgsPalettedRasterRenderer: public QgsRasterRenderer
     QgsPalettedRasterRenderer( QgsRasterInterface* input, int bandNumber, QRgb* colorArray, int nColors, const QVector<QString>& labels = QVector<QString>() );
     ~QgsPalettedRasterRenderer();
 
+    //! QgsPalettedRasterRenderer cannot be copied. Use clone() instead.
     QgsPalettedRasterRenderer( const QgsPalettedRasterRenderer& ) = delete;
+    //! QgsPalettedRasterRenderer cannot be copied. Use clone() instead.
     const QgsPalettedRasterRenderer& operator=( const QgsPalettedRasterRenderer& ) = delete;
 
     QgsPalettedRasterRenderer * clone() const override;

diff --git a/src/core/raster/qgsrasterrenderer.h b/src/core/raster/qgsrasterrenderer.h
@@ -43,7 +43,9 @@ class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface
     QgsRasterRenderer( QgsRasterInterface* input = nullptr, const QString& type = "" );
     virtual ~QgsRasterRenderer();
 
+    //! QgsRasterRenderer cannot be copied. Use clone() instead.
     QgsRasterRenderer( const QgsRasterRenderer& ) = delete;
+    //! QgsRasterRenderer cannot be copied. Use clone() instead.
     const QgsRasterRenderer& operator=( const QgsRasterRenderer& ) = delete;
 
     QgsRasterRenderer * clone() const override = 0;

diff --git a/src/core/raster/qgsrastershader.h b/src/core/raster/qgsrastershader.h
@@ -34,7 +34,9 @@ class CORE_EXPORT QgsRasterShader
     QgsRasterShader( double theMinimumValue = 0.0, double theMaximumValue = 255.0 );
     ~QgsRasterShader();
 
+    //! QgsRasterShader cannot be copied
     QgsRasterShader( const QgsRasterShader& rh ) = delete;
+    //! QgsRasterShader cannot be copied
     QgsRasterShader& operator=( const QgsRasterShader& rh ) = delete;
 
     /*
@@ -72,8 +74,14 @@ class CORE_EXPORT QgsRasterShader
     //! \brief Return the minimum value
     void setMinimumValue( double );
 
+    /**
+     * Writes shader state to an XML element.
+     */
     void writeXml( QDomDocument& doc, QDomElement& parent ) const;
 
+    /**
+     * Reads shader state from an XML element.
+     */
     void readXml( const QDomElement& elem );
 
   private:

diff --git a/src/core/raster/qgssinglebandcolordatarenderer.h b/src/core/raster/qgssinglebandcolordatarenderer.h
@@ -30,7 +30,9 @@ class CORE_EXPORT QgsSingleBandColorDataRenderer: public QgsRasterRenderer
   public:
     QgsSingleBandColorDataRenderer( QgsRasterInterface* input, int band );
 
+    //! QgsSingleBandColorDataRenderer cannot be copied. Use clone() instead.
     QgsSingleBandColorDataRenderer( const QgsSingleBandColorDataRenderer& ) = delete;
+    //! QgsSingleBandColorDataRenderer cannot be copied. Use clone() instead.
     const QgsSingleBandColorDataRenderer& operator=( const QgsSingleBandColorDataRenderer& ) = delete;
 
     QgsSingleBandColorDataRenderer * clone() const override;

diff --git a/src/core/raster/qgssinglebandgrayrenderer.h b/src/core/raster/qgssinglebandgrayrenderer.h
@@ -38,7 +38,9 @@ class CORE_EXPORT QgsSingleBandGrayRenderer: public QgsRasterRenderer
     QgsSingleBandGrayRenderer( QgsRasterInterface* input, int grayBand );
     ~QgsSingleBandGrayRenderer();
 
+    //! QgsSingleBandGrayRenderer cannot be copied. Use clone() instead.
     QgsSingleBandGrayRenderer( const QgsSingleBandGrayRenderer& ) = delete;
+    //! QgsSingleBandGrayRenderer cannot be copied. Use clone() instead.
     const QgsSingleBandGrayRenderer& operator=( const QgsSingleBandGrayRenderer& ) = delete;
 
     QgsSingleBandGrayRenderer * clone() const override;

diff --git a/src/core/raster/qgssinglebandpseudocolorrenderer.h b/src/core/raster/qgssinglebandpseudocolorrenderer.h
@@ -38,7 +38,9 @@ class CORE_EXPORT QgsSingleBandPseudoColorRenderer: public QgsRasterRenderer
     QgsSingleBandPseudoColorRenderer( QgsRasterInterface* input, int band = -1, QgsRasterShader* shader = nullptr );
     ~QgsSingleBandPseudoColorRenderer();
 
+    //! QgsSingleBandPseudoColorRenderer cannot be copied. Use clone() instead.
     QgsSingleBandPseudoColorRenderer( const QgsSingleBandPseudoColorRenderer& ) = delete;
+    //! QgsSingleBandPseudoColorRenderer cannot be copied. Use clone() instead.
     const QgsSingleBandPseudoColorRenderer& operator=( const QgsSingleBandPseudoColorRenderer& ) = delete;
 
     QgsSingleBandPseudoColorRenderer * clone() const override;

diff --git a/src/core/symbology-ng/qgscptcityarchive.h b/src/core/symbology-ng/qgscptcityarchive.h
@@ -41,7 +41,9 @@ class CORE_EXPORT QgsCptCityArchive
                        const QString& baseDir = QString() );
     ~QgsCptCityArchive();
 
+    //! QgsCptCityArchive cannot be copied
     QgsCptCityArchive( const QgsCptCityArchive& rh ) = delete;
+    //! QgsCptCityArchive cannot be copied
     QgsCptCityArchive& operator=( const QgsCptCityArchive& rh ) = delete;
 
     // basic dir info

diff --git a/src/core/symbology-ng/qgsrendererregistry.h b/src/core/symbology-ng/qgsrendererregistry.h
@@ -187,7 +187,9 @@ class CORE_EXPORT QgsRendererRegistry
     QgsRendererRegistry();
     ~QgsRendererRegistry();
 
+    //! QgsRendererRegistry cannot be copied.
     QgsRendererRegistry( const QgsRendererRegistry& rh ) = delete;
+    //! QgsRendererRegistry cannot be copied.
     QgsRendererRegistry& operator=( const QgsRendererRegistry& rh ) = delete;
 
     //! Adds a renderer to the registry. Takes ownership of the metadata object.

diff --git a/src/core/symbology-ng/qgsrulebasedrenderer.h b/src/core/symbology-ng/qgsrulebasedrenderer.h
@@ -123,7 +123,9 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer
               const QString& label = QString(), const QString& description = QString(), bool elseRule = false );
         ~Rule();
 
+        //! Rules cannot be copied
         Rule( const Rule& rh ) = delete;
+        //! Rules cannot be copied
         Rule& operator=( const Rule& rh ) = delete;
 
         /**

diff --git a/src/core/symbology-ng/qgssvgcache.h b/src/core/symbology-ng/qgssvgcache.h
@@ -52,7 +52,9 @@ class CORE_EXPORT QgsSvgCacheEntry
     QgsSvgCacheEntry( const QString& file, double size, double outlineWidth, double widthScaleFactor, double rasterScaleFactor, const QColor& fill, const QColor& outline, const QString& lookupKey = QString() );
     ~QgsSvgCacheEntry();
 
+    //! QgsSvgCacheEntry cannot be copied.
     QgsSvgCacheEntry( const QgsSvgCacheEntry& rh ) = delete;
+    //! QgsSvgCacheEntry cannot be copied.
     QgsSvgCacheEntry& operator=( const QgsSvgCacheEntry& rh ) = delete;
 
     //! Absolute path to SVG file

diff --git a/src/core/symbology-ng/qgssymbollayerregistry.h b/src/core/symbology-ng/qgssymbollayerregistry.h
@@ -123,7 +123,9 @@ class CORE_EXPORT QgsSymbolLayerRegistry
     QgsSymbolLayerRegistry();
     ~QgsSymbolLayerRegistry();
 
+    //! QgsSymbolLayerRegistry cannot be copied.
     QgsSymbolLayerRegistry( const QgsSymbolLayerRegistry& rh ) = delete;
+    //! QgsSymbolLayerRegistry cannot be copied.
     QgsSymbolLayerRegistry& operator=( const QgsSymbolLayerRegistry& rh ) = delete;
 
     //! return metadata for specified symbol layer. Returns NULL if not found