doxygen, init in header

qgis · Feb 12, 2018 · 2a7aeaf · 2a7aeaf
1 parent 53f4464
commit 2a7aeaf
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 15 deletions.
diff --git a/python/core/dxf/qgsdxfexport.sip.in b/python/core/dxf/qgsdxfexport.sip.in
@@ -23,13 +23,19 @@ class QgsDxfExport
 
     struct DxfLayer
     {
-      DxfLayer( QgsVectorLayer *vl, int layerOutputAttributeIndex = -1 );
+        DxfLayer( QgsVectorLayer *vl, int layerOutputAttributeIndex = -1 );
 
-      QgsVectorLayer *layer() const;
-      int layerOutputAttributeIndex() const;
+        QgsVectorLayer *layer() const;
+%Docstring
+Return the layer
+%End
+
+        int layerOutputAttributeIndex() const;
+%Docstring
+Return the attribute index used to split into multiple layers.
+The attribute value is used for layer names.
+%End
 
-      QgsVectorLayer *mLayer;
-      int mLayerOutputAttributeIndex;
     };
 
     enum SymbologyExport

diff --git a/src/core/dxf/qgsdxfexport.h b/src/core/dxf/qgsdxfexport.h
@@ -58,16 +58,23 @@ class CORE_EXPORT QgsDxfExport
      */
     struct DxfLayer
     {
-      DxfLayer( QgsVectorLayer *vl, int layerOutputAttributeIndex = -1 )
-        : mLayer( vl )
-        , mLayerOutputAttributeIndex( layerOutputAttributeIndex )
-      {}
-
-      QgsVectorLayer *layer() const {return mLayer;}
-      int layerOutputAttributeIndex() const {return mLayerOutputAttributeIndex;}
-
-      QgsVectorLayer *mLayer;
-      int mLayerOutputAttributeIndex;
+        DxfLayer( QgsVectorLayer *vl, int layerOutputAttributeIndex = -1 )
+          : mLayer( vl )
+          , mLayerOutputAttributeIndex( layerOutputAttributeIndex )
+        {}
+
+        //! Return the layer
+        QgsVectorLayer *layer() const {return mLayer;}
+
+        /**
+         * Return the attribute index used to split into multiple layers.
+         * The attribute value is used for layer names.
+         */
+        int layerOutputAttributeIndex() const {return mLayerOutputAttributeIndex;}
+
+      private:
+        QgsVectorLayer *mLayer = nullptr;
+        int mLayerOutputAttributeIndex = -1;
     };
 
     enum SymbologyExport