Re: [Qemu-devel] [PATCH v6 10/25] replay: introduce breakpoint at the specified step

[Peter Maydell]

On 24 September 2018 at 14:02, Markus Armbruster <address@hidden> wrote:
> "Pavel Dovgalyuk" <address@hidden> writes:
>> This is a doxygen-style comment for automatic documentation generation.
>
> We don't generate documentation, yet.
>
> We do have many GTKDoc-style comments.  Perhaps because we hope that if
> we only add enough of them, they'll become sentient and edit the
> Makefiles to generate documentation.

This is on my todo list. (It got bumped by more important things
and also because somebody else said they were going to look at it,
and then it got bumped off *their* todo list by more important
things :-))

> Adding Doxygen-style to the mix can only make this harder.  Please don't.

Agreed on this part. The doc comment format we want to converge on
is Linux-kernel-style doc-comments. (The plan is to use Sphinx
and borrow the kernel's Sphinx plugin for doc-comment handling.)

thanks
-- PMM