update docstring

qgis · Jul 20, 2022 · 4b1d8b7 · 4b1d8b7
1 parent 9457643
commit 4b1d8b7
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 10 deletions.
diff --git a/python/core/auto_generated/qgsogcutils.sip.in b/python/core/auto_generated/qgsogcutils.sip.in
@@ -177,10 +177,11 @@ Returns an expression from a WFS filter embedded in a document.
     static QDomElement expressionToOgcExpression( const QgsExpression &exp, QDomDocument &doc, QString *errorMessage = 0,
         bool requiresFilterElement = false );
 %Docstring
-Creates an OGC expression XML element.
+Creates an OGC expression XML element from the ``exp`` expression
+with default values for the geometry name, srs name, honourAsisOrientation and invertAxisOrientation.
 
-:return: valid OGC expression QDomElement on success or a valid \verbatim <Filter> QDomElement when:param requiresFilterElement: is set.
-          otherwise null QDomElement
+:return: valid OGC expression QDomElement on success or a valid \verbatim <Filter> \endverbatim QDomElement when ``requiresFilterElement`` is set.
+         otherwise null QDomElement
 %End
 
     static QDomElement expressionToOgcExpression( const QgsExpression &exp,
@@ -194,10 +195,10 @@ Creates an OGC expression XML element.
         QString *errorMessage = 0,
         bool requiresFilterElement = false );
 %Docstring
-Creates an OGC expression XML element.
+Creates an OGC expression XML element from the ``exp`` expression.
 
-:return: valid OGC expression QDomElement on success or a valid \verbatim <Filter> QDomElement when:param requiresFilterElement: is set.
-          otherwise null QDomElement
+:return: valid OGC expression QDomElement on success or a valid \verbatim <Filter> \endverbatim QDomElement when ``requiresFilterElement`` is set.
+         otherwise null QDomElement
 %End
 
 

diff --git a/src/core/qgsogcutils.h b/src/core/qgsogcutils.h
@@ -210,16 +210,17 @@ class CORE_EXPORT QgsOgcUtils
         QString *errorMessage = nullptr ) SIP_SKIP;
 
     /**
-     * Creates an OGC expression XML element.
-     * \returns valid OGC expression QDomElement on success or a valid \verbatim <Filter> QDomElement when \param requiresFilterElement is set.
+     * Creates an OGC expression XML element from the \a exp expression
+     * with default values for the geometry name, srs name, honourAsisOrientation and invertAxisOrientation.
+     * \returns valid OGC expression QDomElement on success or a valid \verbatim <Filter> \endverbatim QDomElement when \a requiresFilterElement is set.
      * otherwise null QDomElement
      */
     static QDomElement expressionToOgcExpression( const QgsExpression &exp, QDomDocument &doc, QString *errorMessage = nullptr,
         bool requiresFilterElement = false );
 
     /**
-     * Creates an OGC expression XML element.
-     * \returns valid OGC expression QDomElement on success or a valid \verbatim <Filter> QDomElement when \param requiresFilterElement is set.
+     * Creates an OGC expression XML element from the \a exp expression.
+     * \returns valid OGC expression QDomElement on success or a valid \verbatim <Filter> \endverbatim QDomElement when \a requiresFilterElement is set.
      * otherwise null QDomElement
      */
     static QDomElement expressionToOgcExpression( const QgsExpression &exp,