lilypond-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] : Supply missing documentation strings in music-function-init.ly


From: Ian Hulin
Subject: [PATCH] : Supply missing documentation strings in music-function-init.ly
Date: Tue, 20 Oct 2009 18:09:12 +0100
User-agent: Thunderbird 2.0.0.23 (X11/20090817)

Please push if these changes look OK.

Cheers,

Ian
>From c602f0c384450a7f7a3500858696ce7132c761e8 Mon Sep 17 00:00:00 2001
From: ian <address@hidden>
Date: Tue, 20 Oct 2009 17:57:04 +0100
Subject: [PATCH] Add missing documentation strings to declarations in
 music-functions-init.ly.

---
 ly/init.ly                 |    4 ++--
 ly/music-functions-init.ly |    9 ++++++++-
 ly/property-init.ly        |    7 +++++++
 3 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/ly/init.ly b/ly/init.ly
index 9304810..6fe41c4 100644
--- a/ly/init.ly
+++ b/ly/init.ly
@@ -7,12 +7,12 @@
 \version "2.12.0"
 
 \include "declarations-init.ly"
-
+#(use-modules (ice-9 q))
 
 #(ly:set-option 'old-relative #f)
 #(define toplevel-scores (list))
 #(define toplevel-bookparts (list))
-#(define output-count 0) 
+#(define output-count 0)            % Now only used in regression tests
 #(define $defaultheader #f)
 #(define $current-book #f)
 #(define $current-bookpart #f)
diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index 718615a..81bbca7 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.ly
@@ -584,11 +584,14 @@ parenthesize =
 
 partcombine =
 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
-               (make-part-combine-music parser
+(_i "Take the music in @var{part1} and @var{part2} and typeset so that they 
share a staff")
+    (make-part-combine-music parser
                                         (list part1 part2)))
 
 pitchedTrill =
 #(define-music-function
+(_i "Print a trill with @var{main-note} as the main note of the trill and 
+print @var{secondary-note} as stemless note head in paretheses")
    (parser location main-note secondary-note)
    (ly:music? ly:music?)
    (let*
@@ -622,6 +625,10 @@ pitchedTrill =
 
 quoteDuring =
 #(define-music-function
+(_i "Indicate a section of music to be quoted.  @var{what} indicates the name 
+of the quoted voice, as specified in a @code{\addquote} command.  
address@hidden is used to indicate the length of music to be quoted;
+usually contains spacers or multi-measure rests.")
   (parser location what main-music)
   (string? ly:music?)
   (make-music 'QuoteMusic
diff --git a/ly/property-init.ly b/ly/property-init.ly
index 4983506..4dd66f9 100644
--- a/ly/property-init.ly
+++ b/ly/property-init.ly
@@ -279,6 +279,8 @@ phrasingSlurNeutral = \revert PhrasingSlur #'direction
 phrasingSlurDashPattern =
 #(define-music-function (parser location dash-fraction dash-period)
   (number? number?)
+(_i "Set up a custom style of dash pattern for @var{dash-fraction} ratio of 
+line to space repeated at @var{dash-period} interval.")
   #{
      \override PhrasingSlur #'dash-definition =
        $(make-simple-dash-definition dash-fraction dash-period)
@@ -301,10 +303,15 @@ phrasingSlurSolid =
 
 pointAndClickOn  =
 #(define-music-function (parser location) ()
+(_i "Enable generation of code in final-format (e.g. pdf) files to reference 
the
+ originating lilypond source statement;
+ this is helpful when developing a score but generates bigger final-format 
files.")
    (ly:set-option 'point-and-click #t)
    (make-music 'SequentialMusic 'void #t))
 pointAndClickOff =
 #(define-music-function (parser location) ()
+(_i "Suppress generating extra code in final-format (e.g. pdf)  files to point 
+ back to the lilypond source statement.")
    (ly:set-option 'point-and-click #f)
    (make-music 'SequentialMusic 'void #t))
 
-- 
1.6.0.4


reply via email to

[Prev in Thread] Current Thread [Next in Thread]