Skip to content
Permalink
Browse files

Improve docs

  • Loading branch information
nyalldawson committed Oct 9, 2020
1 parent 4ee9feb commit cddcbe076a6a6aa04eeeb7509337aeffce8f4de9
Showing with 11 additions and 11 deletions.
  1. +5 −5 python/core/auto_generated/qgsvectorlayer.sip.in
  2. +6 −6 src/core/qgsvectorlayer.h
@@ -867,9 +867,9 @@ Resolves references to other layers (kept as layer IDs after reading XML) into l
%Docstring
Saves named and sld style of the layer to the style table in the db.

:param name:
:param description:
:param useAsDefault:
:param name: Style name
:param description: A description of the style
:param useAsDefault: Set to ``True`` if style should be used as the default style for the layer
:param uiFileContent:
%End

@@ -883,7 +883,7 @@ Lists all the style in db split into related to the layer and not related to

:return: - the number of styles related to current layer (-1 on not implemented)
- descriptions: the list in which will be stored the style descriptions
- msgError:
- msgError: will be set to a descriptive error message if any occurs

.. note::

@@ -902,7 +902,7 @@ Deletes a style from the database
:param styleId: the provider's layer_styles table id of the style to delete

:return: - ``True`` in case of success
- msgError: reference to string that will be updated with any error messages
- msgError: will be set to a descriptive error message if any occurs

.. versionadded:: 3.0
%End
@@ -925,11 +925,11 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte

/**
* Saves named and sld style of the layer to the style table in the db.
* \param name
* \param description
* \param useAsDefault
* \param name Style name
* \param description A description of the style
* \param useAsDefault Set to TRUE if style should be used as the default style for the layer
* \param uiFileContent
* \param msgError
* \param msgError will be set to a descriptive error message if any occurs
*/
virtual void saveStyleToDatabase( const QString &name, const QString &description,
bool useAsDefault, const QString &uiFileContent,
@@ -940,7 +940,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
* \param ids the list in which will be stored the style db ids
* \param names the list in which will be stored the style names
* \param descriptions the list in which will be stored the style descriptions
* \param msgError
* \param msgError will be set to a descriptive error message if any occurs
* \returns the number of styles related to current layer (-1 on not implemented)
* \note Since QGIS 3.2 Styles related to the layer are ordered with the default style first then by update time for Postgres, MySQL and Spatialite.
*/
@@ -955,7 +955,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
/**
* Deletes a style from the database
* \param styleId the provider's layer_styles table id of the style to delete
* \param msgError reference to string that will be updated with any error messages
* \param msgError will be set to a descriptive error message if any occurs
* \returns TRUE in case of success
* \since QGIS 3.0
*/

0 comments on commit cddcbe0

Please sign in to comment.
You can’t perform that action at this time.