Doxy

qgis · Dec 21, 2022 · 644a99d · 644a99d
1 parent 118c956
commit 644a99d
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 10 deletions.
diff --git a/python/core/auto_generated/qgssldexportcontext.sip.in b/python/core/auto_generated/qgssldexportcontext.sip.in
@@ -10,10 +10,9 @@
 class QgsSldExportContext
 {
 %Docstring(signature="appended")
-/ingroup core
-/brief The :py:class:`QgsSldExportContext` class holds SLD export options and other information related to SLD export of a QGIS layer style.
+The :py:class:`QgsSldExportContext` class holds SLD export options and other information related to SLD export of a QGIS layer style.
 
-/since QGIS 3.30
+.. versionadded:: 3.30
 %End
 
 %TypeHeaderCode
@@ -22,8 +21,17 @@ class QgsSldExportContext
   public:
 
     QgsSldExportContext();
+%Docstring
+Constructs a default SLD export context
+%End
+
     ~QgsSldExportContext();
+
     QgsSldExportContext( const QgsSldExportContext &other );
+%Docstring
+Constructs a copy of SLD export context ``other``
+%End
+
 
     QgsSldExportContext( const Qgis::SldExportOptions &options, const Qgis::SldExportVendorExtension &vendorExtension, const QString &filePath );
 %Docstring
@@ -34,13 +42,34 @@ class QgsSldExportContext
 %End
 
     Qgis::SldExportOptions exportOptions() const;
+%Docstring
+Returns the export options
+%End
+
     void setExportOptions( const Qgis::SldExportOptions &exportOptions );
+%Docstring
+Set export options to ``exportOptions``
+%End
 
     Qgis::SldExportVendorExtension vendorExtensions() const;
-    void setVendorExtensions( const Qgis::SldExportVendorExtension &vendorExtensions );
+%Docstring
+Returns the vendor extension enabled for the SLD export
+%End
+
+    void setVendorExtension( const Qgis::SldExportVendorExtension &vendorExtension );
+%Docstring
+Sets the vendor extensions to ``vendorExtension``
+%End
 
     QString exportFilePath() const;
+%Docstring
+Returns the export file path for the SLD
+%End
+
     void setExportFilePath( const QString &exportFilePath );
+%Docstring
+Sets the export file path for the SLD to ``exportFilePath``
+%End
 
 };
 

diff --git a/src/core/qgssldexportcontext.cpp b/src/core/qgssldexportcontext.cpp
@@ -38,9 +38,9 @@ Qgis::SldExportVendorExtension QgsSldExportContext::vendorExtensions() const
   return mVendorExtensions;
 }
 
-void QgsSldExportContext::setVendorExtensions( const Qgis::SldExportVendorExtension &vendorExtensions )
+void QgsSldExportContext::setVendorExtension( const Qgis::SldExportVendorExtension &vendorExtension )
 {
-  mVendorExtensions = vendorExtensions;
+  mVendorExtensions = vendorExtension;
 }
 
 QString QgsSldExportContext::exportFilePath() const

diff --git a/src/core/qgssldexportcontext.h b/src/core/qgssldexportcontext.h
@@ -20,18 +20,30 @@
 #include "qgis_core.h"
 
 /**
- * /ingroup core
- * /brief The QgsSldExportContext class holds SLD export options and other information related to SLD export of a QGIS layer style.
+ * \ingroup core
+ * \brief The QgsSldExportContext class holds SLD export options and other information related to SLD export of a QGIS layer style.
  *
- * /since QGIS 3.30
+ * \since QGIS 3.30
  */
 class CORE_EXPORT QgsSldExportContext
 {
   public:
 
+    /**
+     * Constructs a default SLD export context
+     */
     QgsSldExportContext() = default;
+
     ~QgsSldExportContext() = default;
+
+    /**
+     * Constructs a copy of SLD export context \a other
+     */
     QgsSldExportContext( const QgsSldExportContext &other ) = default;
+
+    /**
+     * Copy the values of \a other into the SLD export context
+     */
     QgsSldExportContext &operator=( const QgsSldExportContext &other ) = default;
 
     /**
@@ -42,13 +54,34 @@ class CORE_EXPORT QgsSldExportContext
      */
     QgsSldExportContext( const Qgis::SldExportOptions &options, const Qgis::SldExportVendorExtension &vendorExtension, const QString &filePath );
 
+    /**
+     * Returns the export options
+     */
     Qgis::SldExportOptions exportOptions() const;
+
+    /**
+     * Set export options to \a exportOptions
+     */
     void setExportOptions( const Qgis::SldExportOptions &exportOptions );
 
+    /**
+     * Returns the vendor extension enabled for the SLD export
+     */
     Qgis::SldExportVendorExtension vendorExtensions() const;
-    void setVendorExtensions( const Qgis::SldExportVendorExtension &vendorExtensions );
 
+    /**
+     * Sets the vendor extensions to \a vendorExtension
+     */
+    void setVendorExtension( const Qgis::SldExportVendorExtension &vendorExtension );
+
+    /**
+     * Returns the export file path for the SLD
+     */
     QString exportFilePath() const;
+
+    /**
+     * Sets the export file path for the SLD to \a exportFilePath
+     */
     void setExportFilePath( const QString &exportFilePath );
 
   private: