add missing doc

qgis · Mar 25, 2019 · e232817 · e232817
1 parent 50f87c1
commit e232817
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
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,