mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-11-10 13:29:48 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Mark up some code examples

Browse source 
These blocks were misformatted in normal paragraph style in the
generated docs. Also, added \comment{} for comments within one code
example.

Signed-off-by: Benjamin Herr <ben@0x539.de>
This commit is contained in:
Benjamin Herr 2014-09-29 17:26:11 +02:00 • committed by Pekka Paalanen
parent 37ffae3164
commit 5b353ad44d
1 changed files with 18 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

32
src/wayland-util.h
View file

@ -89,27 +89,31 @@ struct wl_interface {
*
* The following code will initialize a list:
*
* struct wl_list foo_list;
* ~~~
* struct wl_list foo_list;
*
* struct item_t {
* int foo;
* struct wl_list link;
* };
* struct item_t item1, item2, item3;
* struct item_t {
* int foo;
* struct wl_list link;
* };
* struct item_t item1, item2, item3;
*
* wl_list_init(&foo_list);
* wl_list_insert(&foo_list, &item1.link); Pushes item1 at the head
* wl_list_insert(&foo_list, &item2.link); Pushes item2 at the head
* wl_list_insert(&item2.link, &item3.link); Pushes item3 after item2
* wl_list_init(&foo_list);
* wl_list_insert(&foo_list, &item1.link); \comment{Pushes item1 at the head}
* wl_list_insert(&foo_list, &item2.link); \comment{Pushes item2 at the head}
* wl_list_insert(&item2.link, &item3.link); \comment{Pushes item3 after item2}
* ~~~
*
* The list now looks like [item2, item3, item1]
*
* Will iterate the list in ascending order:
*
* item_t *item;
* wl_list_for_each(item, foo_list, link) {
* Do_something_with_item(item);
* }
* \code
* item_t *item;
* wl_list_for_each(item, foo_list, link) {
* Do_something_with_item(item);
* }
* \endcode
*/
struct wl_list {
struct wl_list *prev;