diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-08-29 06:41:02 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-08-29 11:56:08 +0300 |
commit | 014276a11cd24825ca9d3ea2e21682a5557d38da (patch) | |
tree | e4a7615b5a396fd0aaff0a9810aae5bae410f892 /source/blender/blenlib/BLI_mesh_boolean.hh | |
parent | bfa78aceed7824e5a5cfcefe6d73d96dc12b0d99 (diff) |
Cleanup: spelling
Diffstat (limited to 'source/blender/blenlib/BLI_mesh_boolean.hh')
-rw-r--r-- | source/blender/blenlib/BLI_mesh_boolean.hh | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/source/blender/blenlib/BLI_mesh_boolean.hh b/source/blender/blenlib/BLI_mesh_boolean.hh index 693639f20f2..cb6fc203dc7 100644 --- a/source/blender/blenlib/BLI_mesh_boolean.hh +++ b/source/blender/blenlib/BLI_mesh_boolean.hh @@ -41,17 +41,17 @@ enum class BoolOpType { /** * Do the boolean operation op on the mesh pm_in. - * The boolean operation has nshapes input shapes. Each is a disjoint subset of the input mesh. + * The boolean operation has \a nshapes input shapes. Each is a disjoint subset of the input mesh. * The shape_fn argument, when applied to an input face argument, says which shape it is in - * (should be a value from -1 to nshapes - 1: if -1, it is not part of any shape). - * The use_self arg says whether or not the function should assume that faces in the + * (should be a value from -1 to `nshapes - 1`: if -1, it is not part of any shape). + * The use_self argument says whether or not the function should assume that faces in the * same shape intersect - if the argument is true, such self-intersections will be found. * Sometimes the caller has already done a triangulation of the faces, * and if so, *pm_triangulated contains a triangulation: if non-null, it contains a mesh * of triangles, each of whose orig_field says which face in pm that triangle belongs to. - * pm arg isn't const because we may populate its verts (for debugging). - * Same goes for the pm_triangulated arg. - * The output IMesh will have faces whose orig fields map back to faces and edges in + * pm argument isn't `const` because we may populate its verts (for debugging). + * Same goes for the pm_triangulated argument. + * The output #IMesh will have faces whose orig fields map back to faces and edges in * the input mesh. */ IMesh boolean_mesh(IMesh &imesh, @@ -63,7 +63,7 @@ IMesh boolean_mesh(IMesh &imesh, IMeshArena *arena); /** - * This is like boolean, but operates on IMesh's whose faces are all triangles. + * This is like boolean, but operates on #IMesh's whose faces are all triangles. * It is exposed mainly for unit testing, at the moment: boolean_mesh() uses * it to do most of its work. */ |