From d50820998df2d86ab02feff31e762b3880d573d3 Mon Sep 17 00:00:00 2001 From: andrew Date: Fri, 9 Jan 2009 12:18:48 -0700 Subject: [PATCH] Docs -- Added docstrings to predefined --- ly/music-functions-init.ly | 14 +++++++++----- ly/predefined-fretboards-init.ly | 4 ++-- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly index 322dfa2511..0a028b21d2 100644 --- a/ly/music-functions-init.ly +++ b/ly/music-functions-init.ly @@ -12,11 +12,13 @@ #(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)) diff --git a/ly/predefined-fretboards-init.ly b/ly/predefined-fretboards-init.ly index b4e8ec75f0..35a6e7560d 100644 --- a/ly/predefined-fretboards-init.ly +++ b/ly/predefined-fretboards-init.ly @@ -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) -- 2.39.5