lilypond-devel
[Top][All Lists]
Advanced

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

Documentation of music functions


From: Carl D. Sorensen
Subject: Documentation of music functions
Date: Wed, 5 Nov 2008 06:44:01 -0700

In the NR 6.3.3. and 6.3.4., there are nice examples of building a music
function.  The music functions are documented with standard Scheme doc
strings:

funcName =
#(define-music-function (parser location var-list) (var-types?)
  "This is the doc string for the function."
   return-value)

In ly/music-function-init.ly, the music functions are documented
differently:

funcName =
#(define-music-function (parser location var-list) (var-types?)
  (_i "This is the doc string for the function.")
   return-value)

What is the difference between these two syntaxes, and which should I use to
add doc-strings to addChordShape, storePredefinedDiagram, pointAndClickOn,
and pointAndClickOff, which are predefineds I created?

Thanks,

Carl





reply via email to

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