]> 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)
committerNeil Puttock <n.puttock@gmail.com>
Sun, 19 Jul 2009 23:17:20 +0000 (00:17 +0100)
(cherry picked from commit a9588406a7bee1d45f5049296f0e76a47606ca9b)

ly/music-functions-init.ly
ly/predefined-fretboards-init.ly

index 011265eaebfe1a194fa5d283c475093ffc3d419c..2dded22e3d77acd2b2dbcab500d6a01a5f893be9 100644 (file)
@@ -649,15 +649,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))))
+#(define-music-function (parser location fraction music) (number-pair? ly:music?)
+   (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
+   (ly:music-compress music
+                     (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 +678,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))
-