]> git.donarmstrong.com Git - lilypond.git/commitdiff
music-iterator.hh: add some comments
authorDavid Kastrup <dak@gnu.org>
Tue, 7 Jul 2015 10:59:51 +0000 (12:59 +0200)
committerDavid Kastrup <dak@gnu.org>
Fri, 24 Jul 2015 13:27:13 +0000 (15:27 +0200)
lily/include/music-iterator.hh

index de53608ed5d9fbaa13bc82248b0550e7a1f04709..214079d23a5f284713a06c94f0fadb7d4aac6006 100644 (file)
@@ -75,6 +75,9 @@ private:
 
 public:
   Moment music_get_length () const;
+  // music_start_mom () is calculated relative to the time where the
+  // iterator occurs in the music stream, so it will usually be
+  // non-zero only for expressions starting with grace notes.
   Moment music_start_mom () const;
   Music_iterator ();
   void report_event (Music *);
@@ -89,6 +92,8 @@ public:
   virtual Moment pending_moment () const;
   virtual bool ok () const;
   virtual bool run_always () const;
+  // process is called with a time relative to the iterator start, so
+  // usually the last processed moment is the same as music_get_length.
   virtual void process (Moment until);
   virtual void derived_mark () const;
   virtual void construct_children ();