[PATCH libinput 5/6] doc: document the base structures so they show up in doxygen

[Peter Hutterer]

On Wed, Dec 10, 2014 at 05:54:12PM +0800, Jonas Ådahl wrote:
> Hi,
> 
> A couple of comments inline:
> 
> 
> On Wed, Dec 10, 2014 at 10:34:03AM +1000, Peter Hutterer wrote:
> > Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
> > ---
> >  src/libinput.h | 34 ++++++++++++++++++++++++++++++++++
> >  1 file changed, 34 insertions(+)
> > 
> > diff --git a/src/libinput.h b/src/libinput.h
> > index d6e0446..7e5d93c 100644
> > --- a/src/libinput.h
> > +++ b/src/libinput.h
> > @@ -302,8 +302,31 @@ enum libinput_event_type {
> >  	LIBINPUT_EVENT_TOUCH_FRAME
> >  };
> >  
> > +/**
> > + * @ingroup base
> > + * @struct libinput
> > + *
> > + * The base handle for accessing libinput. This struct is refcounted, use
> > + * libinput_ref() and libinput_unref().
> 
> Maybe "A handle for accessing a libinput context" instead? We don't have
> any non-base context handles so "base" here is a bit unnecessary.

fixed

> > + */
> >  struct libinput;
> > +
> > +/**
> > + * @ingroup device
> > + * @struct libinput_device
> > + *
> > + * The base handle for accessing libinput devices. This struct is
> > + * refcounted, use libinput_device_ref() and libinput_device_unref().
> > + */
> >  struct libinput_device;
> > +
> > +/**
> > + * @ingroup seat
> > + * @struct libinput_seat
> > + *
> > + * The base handle for accessing libinput seats. This struct is
> > + * refcounted, use libinput_seat_ref() and libinput_seat_unref().
> > + */
> >  struct libinput_seat;
> 
> Would it be better to use "A base handle" instead of "The base handle"
> here, as they are not "the" handle for anything.

fixed, thanks

Cheers,
   Peter
 
> >  
> >  /**
> > @@ -919,6 +942,17 @@ libinput_event_touch_get_base_event(struct libinput_event_touch *event);
> >   * @defgroup base Initialization and manipulation of libinput contexts
> >   */
> >  
> > +/**
> > + * @ingroup base
> > + * @struct libinput_interface
> > + *
> > + * libinput does not open file descriptors to devices directly, instead
> > + * open_restricted() and close_restricted() are called for each path that
> > + * must be opened.
> > + *
> > + * @see libinput_udev_create_context
> > + * @see libinput_path_create_context
> > + */
> >  struct libinput_interface {
> >  	/**
> >  	 * Open the device at the given path with the flags provided and
> > -- 
> > 2.1.0
> > 
> 
> 
> Jonas