Re: [Qemu-devel] [PATCH v6 01/26] qemu: add Error to typedefs

["Michael S. Tsirkin" <mst@redhat.com>]

On Mon, Sep 30, 2013 at 05:55:50PM +0200, Andreas Färber wrote:
> Am 30.09.2013 17:50, schrieb Michael S. Tsirkin:
> > On Tue, Oct 01, 2013 at 12:10:52AM +0900, Peter Maydell wrote:
> >> On 30 September 2013 23:40, Michael S. Tsirkin <mst@redhat.com> wrote:
> >>> diff --git a/include/qapi/error.h b/include/qapi/error.h
> >>> index 7d4c696..b85e996 100644
> >>> --- a/include/qapi/error.h
> >>> +++ b/include/qapi/error.h
> >>> @@ -13,14 +13,15 @@
> >>>  #define ERROR_H
> >>>
> >>>  #include "qemu/compiler.h"
> >>> +#include "qemu/typedefs.h"
> >>>  #include "qapi-types.h"
> >>>  #include <stdbool.h>
> >>>
> >>>  /**
> >>> - * A class representing internal errors within QEMU.  An error has a ErrorClass
> >>> + * Error:
> >>> + * An object representing internal errors within QEMU.  An error has a ErrorClass
> >>>   * code and a human message.
> >>>   */
> >>> -typedef struct Error Error;
> >>
> >> Does the process-doc-comments tool really cope with documentation comments
> >> that are completely separate from the typedef like this?
> >>
> >> thanks
> >> -- PMM
> > 
> > Do we care?
> > Downstreams don't seem to package it, most people probably use
> > editor tags anyway ...
> > If yes we can put this all in #if 0.
> 
> Can we turn the typedef into just struct Error here? The doc comment can
> be applied to either.
> 
> Andreas

It won't index Error typedef then though.

How does one run this process-doc-comments tool by the way?

> -- 
> SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
> GF: Jeff Hawn, Jennifer Guild, Felix Imendörffer; HRB 16746 AG Nürnberg