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

Re: [libvirt] [PATCH 10/13] Add support for an explicit RTC change event



On Mon, Mar 22, 2010 at 04:20:59PM +0000, Daniel P. Berrange wrote:
> On Mon, Mar 22, 2010 at 05:17:42PM +0100, Daniel Veillard wrote:
> > [...]
> > > --- a/include/libvirt/libvirt.h.in
> > > +++ b/include/libvirt/libvirt.h.in
> > > @@ -1842,6 +1842,10 @@ int virDomainAbortJob(virDomainPtr dom);
> > >  typedef void (*virConnectDomainEventGenericCallback)(virConnectPtr conn,
> > >                                                       virDomainPtr dom,
> > >                                                       void *opaque);
> > 
> > > +typedef void (*virConnectDomainEventRTCChangeCallback)(virConnectPtr conn,
> > > +                                                       virDomainPtr dom,
> > > +                                                       long long utcoffset,
> > > +                                                       void *opaque);
> > 
> >   I think the time unit of the offset should be documented there, and
> > maybe a bit of explanation people may get confused and expect the offset
> > to be relative to the previous offset instead of absolute
> 
> Where should we put API docs for typedef's like this ?  If I add the
> magic /** style comments in the header, will the docs generator pick
> them up, or should I put them in the libvirt.c file instead ?

  the generator recognize functions type like this so /** style should
  work here, yes :-)

Daniel

-- 
Daniel Veillard      | libxml Gnome XML XSLT toolkit  http://xmlsoft.org/
daniel veillard com  | Rpmfind RPM search engine http://rpmfind.net/
http://veillard.com/ | virtualization library  http://libvirt.org/


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