Re: [PATCH wayland 1/2] util: Document wl_list methods

2016-08-31 Thread Pekka Paalanen
Hi Yong, you may have missed the comment that this fundamental list design comes from the kernel. On Fri, 26 Aug 2016 11:12:59 +0200 Giulio Camuffo wrote: > Hi, > > > > > > +/** > > + * Removes an element from the list. > > + * > > + * \param elm element to remove from the list > > + */ >

Re: [PATCH wayland 1/2] util: Document wl_list methods

2016-08-28 Thread Giulio Camuffo
Il 26/ago/2016 16:28, "Yong Bakos" ha scritto: > > On Aug 26, 2016, at 2:12 AM, Giulio Camuffo wrote: > > > > Hi, > > > > > >> > >> +/** > >> + * Removes an element from the list. > >> + * > >> + * \param elm element to remove from the list > >> + */ > > I think this should mention that elm is le

Re: [PATCH wayland 1/2] util: Document wl_list methods

2016-08-26 Thread Yong Bakos
On Aug 26, 2016, at 2:12 AM, Giulio Camuffo wrote: > > Hi, > > >> >> +/** >> + * Removes an element from the list. >> + * >> + * \param elm element to remove from the list >> + */ > I think this should mention that elm is left in an invalid state, and > the user should call wl_list_init on it

Re: [PATCH wayland 1/2] util: Document wl_list methods

2016-08-26 Thread Giulio Camuffo
Hi, > > +/** > + * Removes an element from the list. > + * > + * \param elm element to remove from the list > + */ I think this should mention that elm is left in an invalid state, and the user should call wl_list_init on it before using it again. Cheers, Giulio > void > wl_list_remove(struct

[PATCH wayland 1/2] util: Document wl_list methods

2016-08-25 Thread Yong Bakos
From: Yong Bakos Add doxygen comment blocks to all wl_list methods. Signed-off-by: Yong Bakos --- src/wayland-util.h | 41 + 1 file changed, 41 insertions(+) diff --git a/src/wayland-util.h b/src/wayland-util.h index cacc122..1044324 100644 --- a/src/wa