[Bf-blender-cvs] [61ad01ec0c2] soc-2020-io-performance: Cleanup: edit comments

[Ankit Meel]

Commit: 61ad01ec0c2a17da4a3e5b768cbad88b33207197
Author: Ankit Meel
Date:   Tue Sep 29 21:41:47 2020 +0530
Branches: soc-2020-io-performance
https://developer.blender.org/rB61ad01ec0c2a17da4a3e5b768cbad88b33207197

Cleanup: edit comments

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

M	source/blender/io/wavefront_obj/intern/obj_export_file_writer.cc
M	source/blender/io/wavefront_obj/intern/obj_export_file_writer.hh
M	source/blender/io/wavefront_obj/intern/obj_exporter.cc

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

diff --git a/source/blender/io/wavefront_obj/intern/obj_export_file_writer.cc b/source/blender/io/wavefront_obj/intern/obj_export_file_writer.cc
index f6c8eb89d16..ce302f13014 100644
--- a/source/blender/io/wavefront_obj/intern/obj_export_file_writer.cc
+++ b/source/blender/io/wavefront_obj/intern/obj_export_file_writer.cc
@@ -121,7 +121,7 @@ void OBJWriter::write_vert_indices(Span<int> vert_indices, Span<int>, Span<int>)
 }
 
 /**
- * Open the OBJ file and write file header.
+ * Try to open the OBJ file and write file header.
  * \return Whether the destination file is writable.
  */
 bool OBJWriter::init_writer(const char *filepath)
diff --git a/source/blender/io/wavefront_obj/intern/obj_export_file_writer.hh b/source/blender/io/wavefront_obj/intern/obj_export_file_writer.hh
index 6a9611eb32d..75a6ad9334e 100644
--- a/source/blender/io/wavefront_obj/intern/obj_export_file_writer.hh
+++ b/source/blender/io/wavefront_obj/intern/obj_export_file_writer.hh
@@ -34,8 +34,8 @@
 namespace blender::io::obj {
 
 /**
- * For an Object, total vertices/ UV vertices/ Normals written by previous objects
- * are added to its indices.
+ * Total vertices/ UV vertices/ Normals written by previous Objects
+ * should be added to the current Object's indices.
  */
 struct IndexOffsets {
   int vertex_offset;
@@ -99,8 +99,10 @@ class OBJWriter {
   void update_index_offsets(const OBJMesh &obj_mesh_data);
 
  private:
-  /* Based on export paramters, a writer function with correct syntax is needed. */
-  typedef void (OBJWriter::*func_vert_uv_normal_indices)(Span<int>, Span<int>, Span<int>) const;
+  /* Based on export parameters, a writer function with correct OBJ syntax is needed. */
+  typedef void (OBJWriter::*func_vert_uv_normal_indices)(Span<int> vert_indices,
+                                                         Span<int> uv_indices,
+                                                         Span<int> normal_indices) const;
 
   func_vert_uv_normal_indices get_poly_element_writer(const OBJMesh &obj_mesh_data);
   void write_vert_uv_normal_indices(Span<int> vert_indices,
diff --git a/source/blender/io/wavefront_obj/intern/obj_exporter.cc b/source/blender/io/wavefront_obj/intern/obj_exporter.cc
index b61d2276aa6..3896bd27d63 100644
--- a/source/blender/io/wavefront_obj/intern/obj_exporter.cc
+++ b/source/blender/io/wavefront_obj/intern/obj_exporter.cc
@@ -186,7 +186,7 @@ static bool insert_frame_in_path(const char *filepath,
  */
 void exporter_main(bContext *C, const OBJExportParams &export_params)
 {
-  /* TODO ankitm: find a better way to exit edit mode that doesn't hit assert
+  /* TODO(ankitm) find a better way to exit edit mode that doesn't hit assert
    * https://hastebin.com/mitihetagi in file F8653460 */
   ED_object_editmode_exit(C, EM_FREEDATA);
   Scene *scene = CTX_data_scene(C);