lib/export/base.rb in tracksperanto-1.6.6 vs lib/export/base.rb in tracksperanto-1.6.7

@@ -23,31 +23,34 @@
   def self.human_name
     "Abstract export format"
   end
   
   # The constructor for an exporter should accept a handle to the IO object that you can write to.
-  # This gets assigned to @io ivar by default, but you can do whatever ypu wish
+  # This gets assigned to @io ivar by default, but you can do whatever you wish
   # By convention, the caller will close the IO when you are done so don't do it here
   def initialize(write_to_io)
     @io = write_to_io
   end
   
   # Called on export start. Will receive the width and height of the comp being exported
   def start_export( img_width, img_height)
   end
   
-  # Called on export end. By convention, the caller will close the IO when you are done so don't do it here
+  # Called on export end. By convention, the caller will close the IO when you are done so don't do it here.
+  # However if you've allocated anything during export (like some Tempfiles) here will be the place to get rid
+  # of them
   def end_export
   end
   
   # Called on tracker start, once for each tracker. Receives the name of the tracker.
   def start_tracker_segment(tracker_name)
   end
   
-  # Called on tracker end
+  # Called on tracker end, once for each tracker
   def end_tracker_segment
   end
   
-  # Called for each tracker keyframe, with the Tracksperanto internal coordinates and frame numbers
+  # Called for each tracker keyframe, with the Tracksperanto internal coordinates and frame numbers.
+  # The calls come after start_tracker_segment and before end_tracker_segment
   def export_point(at_frame_i, abs_float_x, abs_float_y, float_residual)
   end
 end
\ No newline at end of file