[PATCH] doc: Removed extra indentation from wl_list code sample

Pekka Paalanen ppaalanen at gmail.com
Wed Nov 26 03:37:38 PST 2014


On Tue, 25 Nov 2014 17:41:03 -0800
Bill Spitzak <spitzak at gmail.com> wrote:

> This is a minor documentation fix. I did not see any asterisks in the
> output as reported by Pekka Paalanen. Using doxygen 1.7.6.1.
> ---
>  src/wayland-util.h |    8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/src/wayland-util.h b/src/wayland-util.h
> index 46f9a81..a4b22b5 100644
> --- a/src/wayland-util.h
> +++ b/src/wayland-util.h
> @@ -107,10 +107,10 @@ struct wl_interface {
>   *
>   * Iterate the list in ascending order:
>   * \code
> - *	item_t *item;
> - *	wl_list_for_each(item, foo_list, link) {
> - *		Do_something_with_item(item);
> - *	}
> + * item_t *item;
> + * wl_list_for_each(item, foo_list, link) {
> + * 	Do_something_with_item(item);
> + * }
>   * \endcode
>   */
>  struct wl_list {

This fixes the indentation, pushed.

I see the asterisks at
$WLD/share/doc/wayland/Wayland/en-US/html/ch05.html#structwl__list
after 'make install'. Looks like the C comment asterisks we use for
style reasons get copied to the output. They appeared when you replaced
~~~ with \code.

My Doxygen is version 1.8.5.


Thanks,
pq


More information about the wayland-devel mailing list