]> git.donarmstrong.com Git - lilypond.git/commitdiff
Docs -- Added docstrings to predefined
authorandrew <andrew@obi-wan.(none)>
Fri, 9 Jan 2009 19:18:48 +0000 (12:18 -0700)
committerCarl Sorensen <c_sorensen@byu.edu>
Mon, 19 Jan 2009 05:05:53 +0000 (22:05 -0700)
ly/music-functions-init.ly
ly/predefined-fretboards-init.ly

index 322dfa251183ce5ffc27bc08a85aa4db170ec0bb..0a028b21d2996c0b7ece89e14159e772a93b5f53 100644 (file)
 #(use-modules (srfi srfi-1))
 
 acciaccatura =
-#(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic)
+#(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
+   (_i "Create an acciaccatura from the following music expression")) 
 
 addQuote =
 #(define-music-function (parser location name music) (string? ly:music?)
-   (_i "Add a piece of music to be quoted ")
+   (_i "Define @var{music} as a quotable music expression named 
+@var{name}")
    (add-quotable parser name music)
    (make-music 'SequentialMusic 'void #t))
 
@@ -27,7 +29,7 @@ afterGrace =
 #(define-music-function
   (parser location main grace)
   (ly:music? ly:music?)
-
+  (_i "Create @var{grace} note(s) after a @var{main} music expression.")
   (let*
       ((main-length (ly:music-length main))
        (fraction  (ly:parser-lookup parser 'afterGraceFraction)))
@@ -50,7 +52,8 @@ afterGrace =
 
 applyMusic =
 #(define-music-function (parser location func music) (procedure? ly:music?)
-               (func music))
+   (_i"Apply procedure @var{func} to @var{music}.")
+  (func music))
 
 
 applyOutput =
@@ -93,6 +96,7 @@ autochange =
 
 applyContext =
 #(define-music-function (parser location proc) (procedure?)
+   (_i "Modify context properties with Scheme procedure@var{proc}.")
                  (make-music 'ApplyContext 
                    'origin location
                    'procedure proc))
@@ -247,7 +251,7 @@ grace =
 addInstrumentDefinition =
 #(define-music-function
    (parser location name lst) (string? list?)
-
+   (_i "Create instrument @var{name} with properties @var{list}.")
    (set! instrument-definitions (acons name lst instrument-definitions))
 
    (make-music 'SequentialMusic 'void #t))
index b4e8ec75f0181b427e253dfb18afc09a6d00e10c..35a6e7560d4b2669d7d2cbac6d853f628770a695 100644 (file)
@@ -21,8 +21,8 @@
 addChordShape =
 #(define-music-function (parser location key-symbol tuning shape-definition)
    (symbol? pair? string-or-pair?)
-   "Add chord shape @code{shape-definition} to the @code{chord-shape-table}
-hash with the key @code{(cons key-symbol tuning)}."
+   (_i "Add chord shape @var{shape-definition} to the @var{chord-shape-table}
+hash with the key @var{(cons key-symbol tuning)}.")
    (hash-set! chord-shape-table
                (cons key-symbol tuning)
                shape-definition)