Slightly better worded QgsVectorFileWriter description

qgis · Apr 19, 2021 · 352856f · 352856f
1 parent b2d20eb
commit 352856f
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 27 deletions.
diff --git a/python/core/auto_generated/qgsvectorfilewriter.sip.in b/python/core/auto_generated/qgsvectorfilewriter.sip.in
@@ -13,10 +13,12 @@
 class QgsVectorFileWriter : QgsFeatureSink
 {
 %Docstring(signature="appended")
-A convenience class for writing vector files to disk.
+A convenience class for writing vector layers to disk based formats (e.g. Shapefiles, GeoPackage).
+
 There are two possibilities how to use this class:
-1. static call to :py:class:`QgsVectorFileWriter`.writeAsVectorFormat(...) which saves the whole vector layer
-2. create an instance of the class and issue calls to addFeature(...)
+
+1. A static call to :py:class:`QgsVectorFileWriter`.writeAsVectorFormat(...) which saves the whole vector layer.
+2. Create an instance of the class and issue calls to addFeature(...).
 %End
 
 %TypeHeaderCode

diff --git a/python/gui/auto_generated/symbology/qgsrendererwidget.sip.in b/python/gui/auto_generated/symbology/qgsrendererwidget.sip.in
@@ -14,6 +14,7 @@ class QgsRendererWidget : QgsPanelWidget
 Base class for renderer settings widgets.
 
 WORKFLOW:
+
 - open renderer dialog with some RENDERER  (never null!)
 - find out which widget to use
 - instantiate it and set in stacked widget

diff --git a/src/3d/chunks/qgschunkqueuejob_p.h b/src/3d/chunks/qgschunkqueuejob_p.h
@@ -48,8 +48,9 @@ namespace Qt3DCore
  * and will be processed by the parent chunked entity.
  *
  * There are currently two types of queue jobs:
- *  1. chunk loaders: prepares all data needed for creation of entities (ChunkLoader sub-class)
- *  2. chunk updaters: given a chunk with already existing entity, it updates the entity (e.g. update texture or geometry)
+ *
+ * 1. chunk loaders: prepares all data needed for creation of entities (ChunkLoader sub-class)
+ * 2. chunk updaters: given a chunk with already existing entity, it updates the entity (e.g. update texture or geometry)
  *
  * \since QGIS 3.0
  */

diff --git a/src/core/qgsfields.h b/src/core/qgsfields.h
@@ -293,9 +293,9 @@ class CORE_EXPORT  QgsFields
      * Looks up field's index from the field name.
      * This method matches in the following order:
      *
-     *  1. The exact field name taking case sensitivity into account
-     *  2. Looks for the field name by case insensitive comparison
-     *  3. The field alias (case insensitive)
+     * 1. The exact field name taking case sensitivity into account
+     * 2. Looks for the field name by case insensitive comparison
+     * 3. The field alias (case insensitive)
      *
      * \param fieldName The name to look for.
      *

diff --git a/src/core/qgsvectorfilewriter.h b/src/core/qgsvectorfilewriter.h
@@ -37,10 +37,12 @@ class QgsFeatureIterator;
 
 /**
  * \ingroup core
-  * \brief A convenience class for writing vector files to disk.
- There are two possibilities how to use this class:
- 1. static call to QgsVectorFileWriter::writeAsVectorFormat(...) which saves the whole vector layer
- 2. create an instance of the class and issue calls to addFeature(...)
+ * \brief A convenience class for writing vector layers to disk based formats (e.g. Shapefiles, GeoPackage).
+ *
+ * There are two possibilities how to use this class:
+ *
+ * 1. A static call to QgsVectorFileWriter::writeAsVectorFormat(...) which saves the whole vector layer.
+ * 2. Create an instance of the class and issue calls to addFeature(...).
  */
 class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink
 {

diff --git a/src/gui/symbology/qgsrendererwidget.h b/src/gui/symbology/qgsrendererwidget.h
@@ -33,13 +33,14 @@ class QgsMapCanvas;
 /**
  * \ingroup gui
  * \brief Base class for renderer settings widgets.
-
-WORKFLOW:
-- open renderer dialog with some RENDERER  (never null!)
-- find out which widget to use
-- instantiate it and set in stacked widget
-- on any change of renderer type, create some default (dummy?) version and change the stacked widget
-- when clicked OK/Apply, get the renderer from active widget and clone it for the layer
+ *
+ * WORKFLOW:
+ *
+ * - open renderer dialog with some RENDERER  (never null!)
+ * - find out which widget to use
+ * - instantiate it and set in stacked widget
+ * - on any change of renderer type, create some default (dummy?) version and change the stacked widget
+ * - when clicked OK/Apply, get the renderer from active widget and clone it for the layer
 */
 class GUI_EXPORT QgsRendererWidget : public QgsPanelWidget
 {

diff --git a/src/providers/wfs/qgswfssourceselect.h b/src/providers/wfs/qgswfssourceselect.h
@@ -81,9 +81,11 @@ class QgsWFSSourceSelect: public QgsAbstractDataSourceWidget, private Ui::QgsWFS
 
     /**
      * Returns the best suited CRS from a set of authority ids
+     *
      * 1. project CRS if contained in the set
      * 2. WGS84 if contained in the set
      * 3. the first entry in the set else
+     *
      * \returns the authority id of the crs or an empty string in case of error
     */
     QString getPreferredCrs( const QSet<QString> &crsSet ) const;

diff --git a/src/python/qgspythonutils.h b/src/python/qgspythonutils.h
@@ -32,15 +32,15 @@ class QgsServerInterface;
 
 
 /**
- All calls to Python functions in QGIS come here.
- This class is a singleton.
-
- Default path for Python plugins is:
- - QgsApplication::qgisSettingsDirPath() + "/python/plugins"
- - QgsApplication::pkgDataPath() + "/python/plugins"
-
+ * All calls to Python functions in QGIS come here.
+ * This class is a singleton.
+ *
+ * Default path for Python plugins is:
+ *
+ * - QgsApplication::qgisSettingsDirPath() + "/python/plugins"
+ * - QgsApplication::pkgDataPath() + "/python/plugins"
+ *
  */
-
 class PYTHON_EXPORT QgsPythonUtils
 {
   public: