From: David Kastrup <dak@gnu.org>
Date: Sun, 12 Feb 2012 17:42:44 +0000 (+0100)
Subject: Document NoteEvent and EventChord a bit better
X-Git-Tag: release/2.15.30-1~17
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=716378b47474a13918dc33d10f79701c7a6f1180;p=lilypond.git

Document NoteEvent and EventChord a bit better
---

diff --git a/scm/define-music-types.scm b/scm/define-music-types.scm
index 0f1b1e619e..8161601b78 100644
--- a/scm/define-music-types.scm
+++ b/scm/define-music-types.scm
@@ -200,7 +200,15 @@ An alternative syntax is @var{note}@code{\\decr} @dots{}
 	))
 
     (EventChord
-     . ((description . "Internally used to group a set of events.")
+     . ((description . "Explicitly entered chords.
+
+When iterated, @code{elements} are converted to events at the current
+timestep, followed by any @code{articulations}.  Per-chord postevents
+attached by the parser just follow any rhythmic events in
+@code{elements} instead of utilizing @code{articulations}.
+
+An unexpanded chord repetition @samp{q} is recognizable by having its
+duration stored in @code{duration}.")
 	(iterator-ctor . ,ly:event-chord-iterator::constructor)
 	(length-callback . ,ly:music-sequence::event-chord-length-callback)
 	(to-relative-callback .
@@ -332,7 +340,12 @@ Note the explicit font switch.")
 	))
 
     (NoteEvent
-     . ((description . "A note.")
+     . ((description . "A note.
+
+Outside of chords, any events in @code{articulations} with a listener
+are broadcast like chord articulations, the others are retained.
+
+For iteration inside of chords, @xref{EventChord}.")
 	(iterator-ctor . ,ly:rhythmic-music-iterator::constructor)
 	(types . (general-music event note-event rhythmic-event
 		  melodic-event))