]> git.donarmstrong.com Git - lilypond.git/commitdiff
Add docstrings to functions in music-functions-init.ly; from Kieren.
authorKieren <kieren_macmillan@sympatico.ca>
Fri, 13 Mar 2009 15:12:29 +0000 (11:12 -0400)
committerCarl Sorensen <c_sorensen@byu.edu>
Tue, 17 Mar 2009 00:14:41 +0000 (18:14 -0600)
ly/music-functions-init.ly
ly/predefined-fretboards-init.ly

index eb74f8715b08376e0c8019c6c47b2c6e2efaff73..6dd33a5fdffcd94eb9017c5b3400c7dbf1bfb3f3 100644 (file)
@@ -651,13 +651,16 @@ resetRelativeOctave  =
 scaleDurations =
 #(define-music-function
                  (parser location fraction music) (number-pair? ly:music?)
-                 (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction))))
+                 (ly:music-compress music
+                 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
+
+                 (ly:make-moment (car fraction) (cdr fraction))))
 
 
 
 shiftDurations =
 #(define-music-function (parser location dur dots arg) (integer? integer? ly:music?)
-   (_i "")
+   (_i "Scale @var{arg} up by a factor of @var{2^dur*(2-(1/2)^dots)}.")
 
    (music-map
     (lambda (x)
@@ -677,7 +680,7 @@ the `parameters' assoc list.")
 
 rightHandFinger =
 #(define-music-function (parser location finger) (number-or-string?)
-   (_i "Define a StrokeFingerEvent")
+   (_i "Apply @var{finger} as a fingering indication.")
 
    (apply make-music
          (append
index 35a6e7560d4b2669d7d2cbac6d853f628770a695..d0f861a40237736e5cb065512dcf669178dc74f0 100644 (file)
@@ -37,9 +37,8 @@ hash with the key @var{(cons key-symbol tuning)}.")
 storePredefinedDiagram =
 #(define-music-function (parser location chord tuning diagram-definition)
   (ly:music? pair? string-or-pair?)
-  "Add predefined fret diagram defined by @code{diagram-definition}
-for the chord pitches @code{chord} and
-the stringTuning @code{tuning}."
+  (_i "Add predefined fret diagram defined by @var{diagram-definition}
+  for the chord pitches @var{chord} and the stringTuning @var{tuning}.")
   (let* ((pitches (event-chord-pitches 
                     (car (extract-named-music chord 'EventChord))))
          (hash-key (cons tuning pitches))
@@ -50,4 +49,3 @@ the stringTuning @code{tuning}."
              hash-key 
              verbose-definition))
   (make-music 'SequentialMusic 'void #t))
-