[Spice-devel] [PATCH spice-gtk 11/12] gtk-doc: fix a few warnings, improve output

[Frediano Ziglio]

> 
> From: Marc-André Lureau <marcandre.lureau at redhat.com>
> 
> Escape special characters with \, fixes:
> html/SpiceUsbDeviceManager.html:741: warning: no link for: "1" -> (<code
> class="literal">1</code>).
> html/SpiceUsbDeviceManager.html:742: warning: no link for: "2" -> (<code
> class="literal">2</code>).
> html/SpiceUsbDeviceManager.html:743: warning: no link for: "3" -> (<code
> class="literal">3</code>).
> html/SpiceUsbDeviceManager.html:744: warning: no link for: "4" -> (<code
> class="literal">4</code>).
> html/SpiceUsbDeviceManager.html:745: warning: no link for: "5" -> (<code
> class="literal">5</code>).
> html/SpiceUsbDeviceManager.html:747: warning: no link for: "s" -> (<code
> class="literal">s</code>).
> html/SpiceUsbDeviceManager.html:747: warning: no link for: "d" -> (<code
> class="literal">d</code>).
> html/SpiceInputsChannel.html:697: warning: no link for: "0xe0" -> (<code
> class="literal">0xe0</code>).
> html/SpiceInputsChannel.html:698: warning: no link for: "0x100" -> (<code
> class="literal">0x100</code>).
> 
> Signed-off-by: Marc-André Lureau <marcandre.lureau at redhat.com>

Acked-by: Frediano Ziglio <fziglio at redhat.com>

> ---
>  src/channel-inputs.c     |  8 ++++----
>  src/usb-device-manager.c | 12 ++++++------
>  2 files changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/src/channel-inputs.c b/src/channel-inputs.c
> index 1e8f956..f8a04aa 100644
> --- a/src/channel-inputs.c
> +++ b/src/channel-inputs.c
> @@ -509,8 +509,8 @@ void
> spice_inputs_channel_button_release(SpiceInputsChannel *channel, gint butto
>  /**
>   * spice_inputs_key_press:
>   * @channel: a #SpiceInputsChannel
> - * @scancode: a PC XT (set 1) key scancode.  For scancodes with an %0xe0
> - *            prefix, drop the prefix and OR the scancode with %0x100.
> + * @scancode: a PC XT (set 1) key scancode.  For scancodes with an \%0xe0
> + *            prefix, drop the prefix and OR the scancode with \%0x100.
>   *
>   * Press a key.
>   *
> @@ -524,8 +524,8 @@ void spice_inputs_key_press(SpiceInputsChannel *channel,
> guint scancode)
>  /**
>   * spice_inputs_channel_key_press:
>   * @channel: a #SpiceInputsChannel
> - * @scancode: a PC XT (set 1) key scancode.  For scancodes with an %0xe0
> - *            prefix, drop the prefix and OR the scancode with %0x100.
> + * @scancode: a PC XT (set 1) key scancode.  For scancodes with an \%0xe0
> + *            prefix, drop the prefix and OR the scancode with \%0x100.
>   *
>   * Press a key.
>   *
> diff --git a/src/usb-device-manager.c b/src/usb-device-manager.c
> index 55b672b..2578350 100644
> --- a/src/usb-device-manager.c
> +++ b/src/usb-device-manager.c
> @@ -1786,13 +1786,13 @@
> spice_usb_device_manager_can_redirect_device(SpiceUsbDeviceManager  *self,
>   * g_free() when no longer needed.
>   *
>   * The @format positional parameters are the following:
> - * - '%%1$s' manufacturer
> - * - '%%2$s' product
> - * - '%%3$s' descriptor (a [vendor_id:product_id] string)
> - * - '%%4$d' bus
> - * - '%%5$d' address
> + * 1. \%s manufacturer
> + * 2. \%s product
> + * 3. \%s descriptor (a [vendor_id:product_id] string)
> + * 4. \%d bus
> + * 5. \%d address
>   *
> - * (the default format string is "%%s %%s %%s at %%d-%%d")
> + * (the default format string is "\%s \%s \%s at \%d-\%d")
>   *
>   * Returns: a newly-allocated string holding the description, or %NULL if
>   failed
>   */

Frediano