More missing docs

qgis · Sep 11, 2017 · 9b04589 · 9b04589
1 parent 6166d21
commit 9b04589
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 0 deletions.
diff --git a/python/analysis/network/qgsgraph.sip b/python/analysis/network/qgsgraph.sip
@@ -107,7 +107,11 @@ class QgsGraph
 #include "qgsgraph.h"
 %End
   public:
+
     QgsGraph();
+%Docstring
+ Constructor for QgsGraph.
+%End
 
 
     int addVertex( const QgsPointXY &pt );

diff --git a/python/core/diagram/qgsdiagram.sip b/python/core/diagram/qgsdiagram.sip
@@ -19,6 +19,7 @@ class QgsDiagram
 #include "qgsdiagram.h"
 %End
   public:
+
     virtual ~QgsDiagram();
 
     virtual QgsDiagram *clone() const = 0 /Factory/;
@@ -71,7 +72,11 @@ Returns the size in map units the diagram will use to render. Interpolate size
 %End
 
   protected:
+
     QgsDiagram();
+%Docstring
+ Constructor for QgsDiagram.
+%End
     QgsDiagram( const QgsDiagram &other );
 
     void setPenWidth( QPen &pen, const QgsDiagramSettings &s, const QgsRenderContext &c );

diff --git a/python/core/qgscredentials.sip b/python/core/qgscredentials.sip
@@ -73,7 +73,11 @@ retrieves instance
 %End
 
   protected:
+
     QgsCredentials();
+%Docstring
+ Constructor for QgsCredentials.
+%End
 
     virtual bool request( const QString &realm, QString &username /In,Out/, QString &password /In,Out/, const QString &message = QString() ) = 0;
 %Docstring

diff --git a/python/core/qgsreadwritecontext.sip b/python/core/qgsreadwritecontext.sip
@@ -20,7 +20,11 @@ class QgsReadWriteContext
 #include "qgsreadwritecontext.h"
 %End
   public:
+
     QgsReadWriteContext();
+%Docstring
+ Constructor for QgsReadWriteContext.
+%End
 
     const QgsPathResolver &pathResolver() const;
 %Docstring

diff --git a/python/core/raster/qgsrastertransparency.sip b/python/core/raster/qgsrastertransparency.sip
@@ -19,7 +19,11 @@ class QgsRasterTransparency
 #include "qgsrastertransparency.h"
 %End
   public:
+
     QgsRasterTransparency();
+%Docstring
+ Constructor for QgsRasterTransparency.
+%End
 
     struct TransparentThreeValuePixel
     {
@@ -87,8 +91,14 @@ True if there are no entries in the pixel lists except the nodata value
 %End
 
     void writeXml( QDomDocument &doc, QDomElement &parentElem ) const;
+%Docstring
+ Writes the transparency information to an XML document.
+%End
 
     void readXml( const QDomElement &elem );
+%Docstring
+ Reads the transparency information from an XML document.
+%End
 
 };
 /************************************************************************

diff --git a/src/analysis/network/qgsgraph.h b/src/analysis/network/qgsgraph.h
@@ -131,6 +131,10 @@ class ANALYSIS_EXPORT QgsGraphVertex
 class ANALYSIS_EXPORT QgsGraph
 {
   public:
+
+    /**
+     * Constructor for QgsGraph.
+     */
     QgsGraph() = default;
 
     // Graph constructing methods

diff --git a/src/core/diagram/qgsdiagram.h b/src/core/diagram/qgsdiagram.h
@@ -37,6 +37,7 @@ class QgsAttributes;
 class CORE_EXPORT QgsDiagram
 {
   public:
+
     virtual ~QgsDiagram() { clearCache(); }
 
     /** Returns an instance that is equivalent to this one
@@ -73,6 +74,10 @@ class CORE_EXPORT QgsDiagram
     virtual double legendSize( double value, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is ) const = 0;
 
   protected:
+
+    /**
+     * Constructor for QgsDiagram.
+     */
     QgsDiagram() = default;
     QgsDiagram( const QgsDiagram &other );
 

diff --git a/src/core/qgscredentials.h b/src/core/qgscredentials.h
@@ -75,6 +75,10 @@ class CORE_EXPORT QgsCredentials
     QMutex *mutex() { return &mMutex; }
 
   protected:
+
+    /**
+     * Constructor for QgsCredentials.
+     */
     QgsCredentials() = default;
 
     //! request a password

diff --git a/src/core/qgsreadwritecontext.h b/src/core/qgsreadwritecontext.h
@@ -29,6 +29,10 @@
 class CORE_EXPORT QgsReadWriteContext
 {
   public:
+
+    /**
+     * Constructor for QgsReadWriteContext.
+     */
     QgsReadWriteContext() = default;
 
     //! Returns path resolver for conversion between relative and absolute paths

diff --git a/src/core/raster/qgsrastertransparency.h b/src/core/raster/qgsrastertransparency.h
@@ -32,6 +32,10 @@ class CORE_EXPORT QgsRasterTransparency
 {
 
   public:
+
+    /**
+     * Constructor for QgsRasterTransparency.
+     */
     QgsRasterTransparency() = default;
 
     //
@@ -82,8 +86,14 @@ class CORE_EXPORT QgsRasterTransparency
     //! True if there are no entries in the pixel lists except the nodata value
     bool isEmpty() const;
 
+    /**
+     * Writes the transparency information to an XML document.
+     */
     void writeXml( QDomDocument &doc, QDomElement &parentElem ) const;
 
+    /**
+     * Reads the transparency information from an XML document.
+     */
     void readXml( const QDomElement &elem );
 
   private: