add missing doc

3nids · 3nids · commit e232817e5bd7 · 2019-03-25T11:00:17.000-05:00
diff --git a/python/core/auto_additions/qgsmaplayer.py b/python/core/auto_additions/qgsmaplayer.py
@@ -9,7 +9,7 @@
 QgsMapLayer.PluginLayer.__doc__ = ""
 QgsMapLayer.MeshLayer = QgsMapLayerType.MeshLayer
 QgsMapLayer.MeshLayer.__doc__ = "Added in 3.2"
-QgsMapLayerType.__doc__ = 'Types of layers that can be added to a map\n\n' + '* VectorLayer: ' + QgsMapLayerType.VectorLayer.__doc__ + '\n' + '* RasterLayer: ' + QgsMapLayerType.RasterLayer.__doc__ + '\n' + '* PluginLayer: ' + QgsMapLayerType.PluginLayer.__doc__ + '\n' + '* MeshLayer: ' + QgsMapLayerType.MeshLayer.__doc__
+QgsMapLayerType.__doc__ = 'Types of layers that can be added to a map\n\n.. versionadded:: 3.8\n\n' + '* VectorLayer: ' + QgsMapLayerType.VectorLayer.__doc__ + '\n' + '* RasterLayer: ' + QgsMapLayerType.RasterLayer.__doc__ + '\n' + '* PluginLayer: ' + QgsMapLayerType.PluginLayer.__doc__ + '\n' + '* MeshLayer: ' + QgsMapLayerType.MeshLayer.__doc__
 # --
 QgsMapLayer.LayerFlag.baseClass = QgsMapLayer
 QgsMapLayer.LayerFlags.baseClass = QgsMapLayer
diff --git a/scripts/sipify.pl b/scripts/sipify.pl
@@ -1010,6 +1010,7 @@ sub detect_non_method_member{
             }
             write_output("ENU4", "$LINE\n");
             if ($is_scope_based eq "1") {
+                $COMMENT =~ s/\n/\\n/g;
                 if ( $ACTUAL_CLASS ne "" ){
                     push @OUTPUT_PYTHON, "$ACTUAL_CLASS.$enum_qualname.__doc__ = '$COMMENT\\n\\n' + " . join(" + '\\n' + ", @enum_members_doc) . "\n# --\n";
                 } else {
diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h
@@ -57,7 +57,11 @@ class QPainter;
 #define QGSCLIPBOARD_MAPLAYER_MIME "application/qgis.maplayer"
 
 
-//! Types of layers that can be added to a map
+/**
+ * \ingroup core
+ * Types of layers that can be added to a map
+ * \since QGIS 3.8
+ */
 enum class QgsMapLayerType SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsMapLayer, LayerType ) : int
   {
   VectorLayer,

Original file line number	Diff line number	Diff line change
`@@ -1010,6 +1010,7 @@ sub detect_non_method_member{`
`1010`	`1010`	`}`
`1011`	`1011`	`write_output("ENU4", "$LINE\n");`
`1012`	`1012`	`if ($is_scope_based eq "1") {`
	`1013`	`+ $COMMENT =~ s/\n/\\n/g;`
`1013`	`1014`	`if ( $ACTUAL_CLASS ne "" ){`
`1014`	`1015`	`push @OUTPUT_PYTHON, "$ACTUAL_CLASS.$enum_qualname.__doc__ = '$COMMENT\\n\\n' + " . join(" + '\\n' + ", @enum_members_doc) . "\n# --\n";`
`1015`	`1016`	`} else {`