doc: Removed extra indentation from wl_list code sample

Submitted by Bill Spitzak on Nov. 26, 2014, 1:41 a.m.

Details

Message ID 1416966063-5536-1-git-send-email-spitzak@gmail.com
State Accepted
Commit 266b7f06bee13b06f2a73cb7330382de69cbf1ce
Headers show

Not browsing as part of any series.

Commit Message

Bill Spitzak Nov. 26, 2014, 1:41 a.m.
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(-)

Patch hide | download patch | download mbox

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 {

Comments

On Tue, 25 Nov 2014 17:41:03 -0800
Bill Spitzak <spitzak@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