Comments In Introspection XML?

[Simon McVittie]

On Fri, 20 Oct 2017 at 07:02:37 +1300, Lawrence D'Oliveiro wrote:
> No reason why that has to be, e.g.:
> 
>     <annotation name="comment">
>         This signal is sent every time the clock chimes.
>         The argument is the number of clock strikes.
>     </annotation>

This is how <annotation> *could have been* designed, but it isn't how
<annotation> *was* designed.

If we're inventing new semantics that existing consumers of
introspection XML don't know how to read, then they should be a new
element.

> > ... or to introduce new elements in a different XML namespace
> > (Telepathy's <tp:docstring> and org.freedesktop.Accounts' <doc>) and
> > define them to contain HTML and/or Docbook.
> 
> Yes, I could adopt something like that. Apart from the HTML or DocBook.

Markdown has also been suggested as a convention in the past.

    smcv