Add docs

qgis · Dec 7, 2020 · df3c30e · df3c30e
1 parent e3dcb5b
commit df3c30e
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 0 deletions.
diff --git a/python/3d/auto_generated/symbols/qgspointcloud3dsymbol.sip.in b/python/3d/auto_generated/symbols/qgspointcloud3dsymbol.sip.in
@@ -394,6 +394,16 @@ Ownership of ``enhancement`` is transferred.
 
 class QgsClassificationPointCloud3DSymbol : QgsPointCloud3DSymbol
 {
+%Docstring
+3D symbol that draws point cloud geometries as 3D objects using classification of the dataset
+
+.. warning::
+
+   This is not considered stable API, and may change in future QGIS releases. It is
+   exposed to the Python bindings as a tech preview only.
+
+.. versionadded:: 3.18
+%End
 
 %TypeHeaderCode
 #include "qgspointcloud3dsymbol.h"
@@ -429,7 +439,18 @@ Sets the parameter used to select the color of the point cloud
 %End
 
     QgsPointCloudCategoryList categoriesList() const;
+%Docstring
+Returns the list of categories of the classification
+
+.. seealso:: :py:func:`setCategoriesList`
+%End
+
     void setCategoriesList( const QgsPointCloudCategoryList &categories );
+%Docstring
+Sets the list of categories of the classification
+
+.. seealso:: :py:func:`categoriesList`
+%End
 
     QgsColorRampShader colorRampShader() const;
 %Docstring

diff --git a/src/3d/symbols/qgspointcloud3dsymbol.h b/src/3d/symbols/qgspointcloud3dsymbol.h
@@ -361,6 +361,15 @@ class _3D_EXPORT QgsRgbPointCloud3DSymbol : public QgsPointCloud3DSymbol
 
 };
 
+/**
+ * \ingroup 3d
+ * 3D symbol that draws point cloud geometries as 3D objects using classification of the dataset
+ *
+ * \warning This is not considered stable API, and may change in future QGIS releases. It is
+ * exposed to the Python bindings as a tech preview only.
+ *
+ * \since QGIS 3.18
+ */
 class _3D_EXPORT QgsClassificationPointCloud3DSymbol : public QgsPointCloud3DSymbol
 {
   public:
@@ -385,7 +394,16 @@ class _3D_EXPORT QgsClassificationPointCloud3DSymbol : public QgsPointCloud3DSym
     */
     void setRenderingParameter( const QString &parameter );
 
+    /**
+     * Returns the list of categories of the classification
+     * \see setCategoriesList()
+     */
     QgsPointCloudCategoryList categoriesList() const { return mCategoriesList; }
+
+    /**
+     * Sets the list of categories of the classification
+     * \see categoriesList()
+     */
     void setCategoriesList( const QgsPointCloudCategoryList &categories );
 
     /**