[Top][All Lists]

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

Re: Block comment syntax for LilyPond API documentation

From: David Kastrup
Subject: Re: Block comment syntax for LilyPond API documentation
Date: Tue, 07 Jul 2015 18:14:42 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/25.0.50 (gnu/linux)

Urs Liska <address@hidden> writes:

> We have thought for some time to develop a specification for API
> documentation in LilyPond files. Mainly for library stuff, but it may
> also be useful for "documents".
> (There's some discussion you may read at
> There seems to be an agreement to mainly use special block comments
> preceding the documented function. The suggestion is
> %{!
>   Enter some documentation, maybe in *Markdown*,
>   together with some fields in a to-be-discussed syntax.
> %}

Well, the general convention of entering documentation is along the
lines of

\header {
  texidoc = "... in Texinfo syntax ..."

LilyPond has a command line option for extracting those kinds of

‘-H, --header=FIELD’
     Dump a header field to file ‘BASENAME.FIELD’.

Of course they don't need to be in Texinfo syntax for that.  At any
rate, in this form they are available also for processing by GUILE.

David Kastrup

reply via email to

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