lilypond-user
[Top][All Lists]
Advanced

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

Block comment syntax for LilyPond API documentation


From: Urs Liska
Subject: Block comment syntax for LilyPond API documentation
Date: Tue, 07 Jul 2015 18:00:49 +0200
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Thunderbird/31.7.0

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
https://github.com/openlilylib/openlilylib/issues/109).

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.
%}

I think this is a good idea, reasonably similar to LilyPond's own block
comments. Before going that route I'd like to ask if anyone sees any
problems with that %{! syntax.
I can't really imagine because after the curly bracket LilyPond
considers this a comment, and so there's no significant risk that this
might interfere with any future parser expectations.
I'd just like to ask, just in case.

Best
Urs



reply via email to

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