Skip to content
Permalink
Browse files

fix documentation

  • Loading branch information
3nids authored and nyalldawson committed Sep 14, 2018
1 parent 5e6c382 commit 0cfa77db7f7abb9a5213d5e3bea72a7f4a0a3cd1
@@ -887,6 +887,7 @@ record in the users style table in their personal qgis.db)
key matches the URI.
:param resultFlag: a reference to a flag that will be set to false if
we did not manage to save the default style.
:param categories: the style categories to be saved.

:return: a QString with any status messages

@@ -878,6 +878,7 @@ Read the symbology for the current layer from the Dom node supplied.
:param layerNode: node that will contain the symbology definition for this layer.
:param errorMessage: reference to string that will be updated with any error messages
:param context: reading context (used for transform from relative to absolute paths)
:param categories: the style categories to be read

:return: true in case of success.
%End
@@ -890,6 +891,7 @@ Read the style for the current layer from the Dom node supplied.
:param node: node that will contain the style definition for this layer.
:param errorMessage: reference to string that will be updated with any error messages
:param context: reading context (used for transform from relative to absolute paths)
:param categories: the style categories to be read

:return: true in case of success.
%End
@@ -903,6 +905,7 @@ Write the symbology for the layer into the docment provided.
:param doc: the document that will have the QDomNode added.
:param errorMessage: reference to string that will be updated with any error messages
:param context: writing context (used for transform from absolute to relative paths)
:param categories: the style categories to be written

:return: true in case of success.
%End
@@ -916,6 +919,7 @@ Write just the style information for the layer into the document
:param doc: the document that will have the QDomNode added.
:param errorMessage: reference to string that will be updated with any error messages
:param context: writing context (used for transform from absolute to relative paths)
:param categories: the style categories to be written

:return: true in case of success.
%End
@@ -743,7 +743,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
* (either as a .qml file on disk or as a
* record in the users style table in their personal qgis.db)
* \returns a QString with the style file name
* \see also loadNamedStyle () and saveNamedStyle ();
* \see also loadNamedStyle() and saveNamedStyle();
*/
virtual QString styleURI() const;

@@ -754,7 +754,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
* \param resultFlag a reference to a flag that will be set to false if
* we did not manage to load the default style.
* \returns a QString with any status messages
* \see also loadNamedStyle ();
* \see also loadNamedStyle();
*/
virtual QString loadDefaultStyle( bool &resultFlag SIP_OUT );

@@ -837,6 +837,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
* key matches the URI.
* \param resultFlag a reference to a flag that will be set to false if
* we did not manage to save the default style.
* \param categories the style categories to be saved.
* \returns a QString with any status messages
* \see saveDefaultStyle()
*/
@@ -2284,7 +2284,7 @@ bool QgsVectorLayer::writeSymbology( QDomNode &node, QDomDocument &doc, QString
QDomElement layerElement = node.toElement();
writeCommonStyle( layerElement, doc, context, categories );

( void )writeStyle( node, doc, errorMessage, context );
( void )writeStyle( node, doc, errorMessage, context, categories );

if ( categories.testFlag( LayerConfiguration ) )
{
@@ -878,6 +878,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
* \param layerNode node that will contain the symbology definition for this layer.
* \param errorMessage reference to string that will be updated with any error messages
* \param context reading context (used for transform from relative to absolute paths)
* \param categories the style categories to be read
* \returns true in case of success.
*/
bool readSymbology( const QDomNode &layerNode, QString &errorMessage,
@@ -888,6 +889,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
* \param node node that will contain the style definition for this layer.
* \param errorMessage reference to string that will be updated with any error messages
* \param context reading context (used for transform from relative to absolute paths)
* \param categories the style categories to be read
* \returns true in case of success.
*/
bool readStyle( const QDomNode &node, QString &errorMessage,
@@ -899,6 +901,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
* \param doc the document that will have the QDomNode added.
* \param errorMessage reference to string that will be updated with any error messages
* \param context writing context (used for transform from absolute to relative paths)
* \param categories the style categories to be written
* \returns true in case of success.
*/
bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage,
@@ -910,6 +913,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
* \param doc the document that will have the QDomNode added.
* \param errorMessage reference to string that will be updated with any error messages
* \param context writing context (used for transform from absolute to relative paths)
* \param categories the style categories to be written
* \returns true in case of success.
*/
bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage,

0 comments on commit 0cfa77d

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