From 20df402adc871a76cd98f7de116c48bebd151ce3 Mon Sep 17 00:00:00 2001
From: Campbell Barton <campbell@blender.org>
Date: Tue, 18 Jan 2022 13:05:07 +1100
Subject: Cleanup: move docs to definition

---
 source/blender/blenkernel/BKE_volume_to_mesh.hh | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'source/blender/blenkernel/BKE_volume_to_mesh.hh')

diff --git a/source/blender/blenkernel/BKE_volume_to_mesh.hh b/source/blender/blenkernel/BKE_volume_to_mesh.hh
index b99ae625042..123cb33f24f 100644
--- a/source/blender/blenkernel/BKE_volume_to_mesh.hh
+++ b/source/blender/blenkernel/BKE_volume_to_mesh.hh
@@ -56,11 +56,20 @@ struct Mesh *volume_to_mesh(const openvdb::GridBase &grid,
                             float threshold,
                             float adaptivity);
 
+/**
+ * Convert an OpenVDB volume grid to corresponding mesh data: vertex positions and quad and
+ * triangle indices.
+ */
 struct OpenVDBMeshData volume_to_mesh_data(const openvdb::GridBase &grid,
                                            const VolumeToMeshResolution &resolution,
                                            float threshold,
                                            float adaptivity);
 
+/**
+ * Convert mesh data from the format provided by OpenVDB into Blender's #Mesh data structure.
+ * This can be used to add mesh data from a grid into an existing mesh rather than merging multiple
+ * meshes later on.
+ */
 void fill_mesh_from_openvdb_data(const Span<openvdb::Vec3s> vdb_verts,
                                  const Span<openvdb::Vec3I> vdb_tris,
                                  const Span<openvdb::Vec4I> vdb_quads,
-- 
cgit v1.2.3