doc: Removed extra indentation from wl_list code sample

Submitted by Bill Spitzak on Nov. 26, 2014, 6:44 p.m.

Details

Message ID 54761F98.9060504@gmail.com
State Rejected
Headers show

Not browsing as part of any series.

Commit Message

Bill Spitzak Nov. 26, 2014, 6:44 p.m.
On 11/26/2014 03:37 AM, Pekka Paalanen wrote:

> 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.

Works for me but the version is different. Can you try the following patch?

Patch hide | download patch | download mbox

diff --git a/src/wayland-util.h b/src/wayland-util.h
index a4b22b5..7146e96 100644
--- a/src/wayland-util.h
+++ b/src/wayland-util.h
@@ -88,6 +88,7 @@  struct wl_interface {
  * "item_t", and the item member as "struct wl_list link".
  *
  * The following code will initialize a list:
+ *
  * \code
  * struct wl_list foo_list;
  *
@@ -106,6 +107,7 @@  struct wl_interface {
  * The list now looks like [item2, item3, item1]
  *
  * Iterate the list in ascending order:
+ *
  * \code
  * item_t *item;
  * wl_list_for_each(item, foo_list, link) {

Comments

On Wed, 26 Nov 2014 10:44:40 -0800
Bill Spitzak <spitzak@gmail.com> wrote:

> On 11/26/2014 03:37 AM, Pekka Paalanen wrote:
> 
> > 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.
> 
> Works for me but the version is different. Can you try the following patch?

The patch doesn't seem to change anything.

For the record, this is what I see in the final HTML (with the patch):

<p>The following code will initialize a list:</p><p>
            </p><pre class="programlisting">* struct <a class="link" href="ch05.html#structwl__list">wl_list</a> foo_list;
*
* struct item_t {
*       int foo;

And this is how it looks like in
doc/publican/en-US/WaylandClientAPI.xml:

          <para>The following code will initialize a list:</para>
          <para>
            <programlisting>* struct <link linkend="structwl__list">wl_list</link> foo_list;
*
* struct item_t {
*       int foo;

So yes, it is a Doxygen thing, I think.

Was there a reason you got rid of the ~~~ markings?


Thanks,
pq