[Bf-blender-cvs] [213bee592c5] temp-vert-normals-cleanup: Add comment

[Hans Goudey]

Commit: 213bee592c5b045736adb9571e5bb2d52a4e2543
Author: Hans Goudey
Date:   Fri Nov 26 10:01:23 2021 -0500
Branches: temp-vert-normals-cleanup
https://developer.blender.org/rB213bee592c5b045736adb9571e5bb2d52a4e2543

Add comment

===================================================================

M	source/blender/blenkernel/BKE_mesh.h

===================================================================

diff --git a/source/blender/blenkernel/BKE_mesh.h b/source/blender/blenkernel/BKE_mesh.h
index c130a5c56bc..b64caa9a98c 100644
--- a/source/blender/blenkernel/BKE_mesh.h
+++ b/source/blender/blenkernel/BKE_mesh.h
@@ -284,6 +284,10 @@ void BKE_mesh_calc_normals_poly(const struct MVert *mvert,
                                 int mpoly_len,
                                 float (*r_poly_normals)[3]);
 void BKE_mesh_calc_normals(struct Mesh *me);
+
+/**
+ * Check that a mesh with non-dirty normals has vertex and face custom data layers.
+ */
 void BKE_mesh_assert_normals_dirty_or_calculated(const struct Mesh *mesh);
 float (*BKE_mesh_vertex_normals_for_write(struct Mesh *mesh))[3];
 float (*BKE_mesh_face_normals_for_write(struct Mesh *mesh))[3];