run sipify all

qgis · Sep 10, 2018 · 4b7da69 · 4b7da69
1 parent 10fc175
commit 4b7da69
Show file tree

Hide file tree

Showing 12 changed files with 45 additions and 45 deletions.
diff --git a/python/core/auto_generated/auth/qgsauthmethod.sip.in b/python/core/auto_generated/auth/qgsauthmethod.sip.in
@@ -23,7 +23,7 @@ Abstract base class for authentication method plugins
 
     enum Expansion
     {
-      // TODO
+      // TODO: Figure out all different authentication expansions current layer providers use
       NetworkRequest,
       NetworkReply,
       DataSourceUri,

diff --git a/python/core/auto_generated/layertree/qgslayertreemodel.sip.in b/python/core/auto_generated/layertree/qgslayertreemodel.sip.in
@@ -76,13 +76,13 @@ The root node is not transferred by the model.
 
     enum Flag
     {
-      // display
+      // display flags
       ShowLegend,
       ShowLegendAsTree,
       DeferredLegendInvalidation,
       UseEmbeddedWidgets,
 
-      // behavioral
+      // behavioral flags
       AllowNodeReorder,
       AllowNodeRename,
       AllowNodeChangeVisibility,

diff --git a/python/core/auto_generated/layout/qgslayoutitemregistry.sip.in b/python/core/auto_generated/layout/qgslayoutitemregistry.sip.in
@@ -153,10 +153,10 @@ of layout items.
       LayoutItem,
       LayoutGroup,
 
-      // known
+      // known item types
 
-      // WARNING
-      // values,
+      // WARNING!!!! SIP CASTING OF QgsLayoutItem and QgsLayoutMultiFrame DEPENDS on these
+      // values, and must be updated if any additional types are added
 
       LayoutPage,
       LayoutMap,
@@ -169,18 +169,18 @@ of layout items.
       LayoutScaleBar,
       LayoutFrame,
 
-      // known
+      // known multi-frame types
 
-      // WARNING
-      // values,
+      // WARNING!!!! SIP CASTING OF QgsLayoutItem and QgsLayoutMultiFrame DEPENDS on these
+      // values, and must be updated if any additional types are added
 
       LayoutHtml,
       LayoutAttributeTable,
       LayoutTextTable,
 
       Layout3DMap,
 
-      // item
+      // item types provided by plugins
       PluginItem,
     };
 

diff --git a/python/core/auto_generated/layout/qgslayoutobject.sip.in b/python/core/auto_generated/layout/qgslayoutobject.sip.in
@@ -27,13 +27,13 @@ A base class for objects which belong to a layout.
       NoProperty,
       AllProperties,
       TestProperty,
-      //composer
+      //composer page properties
       PresetPaperSize,
       PaperWidth,
       PaperHeight,
       NumPages,
       PaperOrientation,
-      //general
+      //general composer item properties
       PageNumber,
       PositionX,
       PositionY,
@@ -46,7 +46,7 @@ A base class for objects which belong to a layout.
       ExcludeFromExports,
       FrameColor,
       BackgroundColor,
-      //composer
+      //composer map
       MapRotation,
       MapScale,
       MapXMin,
@@ -56,22 +56,22 @@ A base class for objects which belong to a layout.
       MapAtlasMargin,
       MapLayers,
       MapStylePreset,
-      //composer
+      //composer picture
       PictureSource,
       PictureSvgBackgroundColor,
       PictureSvgStrokeColor,
       PictureSvgStrokeWidth,
-      //html
+      //html item
       SourceUrl,
-      //legend
+      //legend item
       LegendTitle,
       LegendColumnCount,
-      //scalebar
+      //scalebar item
       ScalebarFillColor,
       ScalebarFillColor2,
       ScalebarLineColor,
       ScalebarLineWidth,
-      //table
+      //table item
       AttributeTableSourceLayer,
     };
 

diff --git a/python/core/auto_generated/processing/qgsprocessingcontext.sip.in b/python/core/auto_generated/processing/qgsprocessingcontext.sip.in
@@ -29,7 +29,7 @@ expression context.
 
     enum Flag
     {
-      // UseSelectionIfPresent,
+      // UseSelectionIfPresent = 1 << 0,
     };
     typedef QFlags<QgsProcessingContext::Flag> Flags;
 

diff --git a/python/core/auto_generated/qgsmapsettings.sip.in b/python/core/auto_generated/qgsmapsettings.sip.in
@@ -234,7 +234,7 @@ Gets color that is used for drawing of selected vector features
       RenderMapTile,
       RenderPartialOutput,
       RenderPreviewJob,
-      // TODO
+      // TODO: ignore scale-based visibility (overview)
     };
     typedef QFlags<QgsMapSettings::Flag> Flags;
 

diff --git a/python/core/auto_generated/qgspallabeling.sip.in b/python/core/auto_generated/qgspallabeling.sip.in
@@ -140,7 +140,7 @@ class QgsPalLayerSettings
 
     enum Property
     {
-      // text
+      // text style
       Size,
       Bold,
       Italic,
@@ -157,7 +157,7 @@ class QgsPalLayerSettings
       FontWordSpacing,
       FontBlendMode,
 
-      // text
+      // text formatting
       MultiLineWrapChar,
       MultiLineHeight,
       MultiLineAlignment,
@@ -170,7 +170,7 @@ class QgsPalLayerSettings
       NumDecimals,
       NumPlusSign,
 
-      // text
+      // text buffer
       BufferDraw,
       BufferSize,
       BufferUnit,
@@ -203,7 +203,7 @@ class QgsPalLayerSettings
       ShapeStrokeWidthUnits,
       ShapeJoinStyle,
 
-      // drop
+      // drop shadow
       ShadowDraw,
       ShadowUnder,
       ShadowOffsetAngle,
@@ -226,7 +226,7 @@ class QgsPalLayerSettings
       DistanceUnits,
       OffsetRotation,
       CurvedCharAngleInOut,
-      // (data
+      // (data defined only)
       PositionX,
       PositionY,
       Hali,
@@ -251,7 +251,7 @@ class QgsPalLayerSettings
       ObstacleFactor,
       ZIndex,
 
-      // (data
+      // (data defined only)
       Show,
       AlwaysShow
     };

diff --git a/python/core/auto_generated/qgstolerance.sip.in b/python/core/auto_generated/qgstolerance.sip.in
@@ -26,11 +26,11 @@ This is the class is providing tolerance value in map unit values.
 
     enum UnitType
     {
-      //! Layer
+      //! Layer unit value
       LayerUnits,
-      //! Pixels
+      //! Pixels unit of tolerance
       Pixels,
-      //! Map
+      //! Map (project) units. Added in 2.8
       ProjectUnits
     };
 

diff --git a/python/core/auto_generated/qgsvectordataprovider.sip.in b/python/core/auto_generated/qgsvectordataprovider.sip.in
@@ -61,9 +61,9 @@ of feature and attribute information from a spatial datasource.
 
     enum FeatureCountState
     {
-      //! Feature
+      //! Feature count not yet computed
       Uncounted,
-      //! Provider
+      //! Provider returned an unknown feature count
       UnknownCount,
     };
 

diff --git a/python/core/auto_generated/qgsvectorfilewriter.sip.in b/python/core/auto_generated/qgsvectorfilewriter.sip.in
@@ -198,16 +198,16 @@ Creates a clone of the FieldValueConverter.
 
     enum EditionCapability
     {
-      //! Flag
+      //! Flag to indicate that a new layer can be added to the dataset
       CanAddNewLayer,
 
-      //! Flag
+      //! Flag to indicate that new features can be added to an existing layer
       CanAppendToExistingLayer,
 
-      //! Flag
+      //! Flag to indicate that new fields can be added to an existing layer. Imply CanAppendToExistingLayer
       CanAddNewFieldsToExistingLayer,
 
-      //! Flag
+      //! Flag to indicate that an existing layer can be deleted
       CanDeleteLayer
     };
 
@@ -216,16 +216,16 @@ Creates a clone of the FieldValueConverter.
 
     enum ActionOnExistingFile
     {
-      //! Create
+      //! Create or overwrite file
       CreateOrOverwriteFile,
 
-      //! Create
+      //! Create or overwrite layer
       CreateOrOverwriteLayer,
 
-      //! Append
+      //! Append features to existing layer, but do not create new fields
       AppendToLayerNoNewFields,
 
-      //! Append
+      //! Append features to existing layer, and create new fields if needed
       AppendToLayerAddFields
     };
 

diff --git a/python/core/auto_generated/raster/qgsrasterminmaxorigin.sip.in b/python/core/auto_generated/raster/qgsrasterminmaxorigin.sip.in
@@ -40,19 +40,19 @@ itself the min/max values.
 
     enum Extent
     {
-      //! Whole
+      //! Whole raster is used to compute statistics.
       WholeRaster,
-      //! Current
+      //! Current extent of the canvas (at the time of computation) is used to compute statistics.
       CurrentCanvas,
-      //! Constantly
+      //! Constantly updated extent of the canvas is used to compute statistics.
       UpdatedCanvas
     };
 
     enum StatAccuracy
     {
-      //! Exact
+      //! Exact statistics.
       Exact,
-      //! Approximated
+      //! Approximated statistics.
       Estimated
     };
 

diff --git a/python/gui/auto_generated/attributetable/qgsattributetablemodel.sip.in b/python/gui/auto_generated/attributetable/qgsattributetablemodel.sip.in
@@ -31,7 +31,7 @@ Is mostly referred to as "master model" within this doc and the source.
       FeatureIdRole,
       FieldIndexRole,
       UserRole,
-      // Insert
+      // Insert new values here, SortRole needs to be the last one
       SortRole,
     };