On Tue, Sep 06, 2016 at 06:36:20AM -0700, Yong Bakos wrote:
> From: Yong Bakos <[email protected]>
> 
> All the doxygen annotations for return values use \return.
> 
> Match this annotation with the existing convention.
> 
> Signed-off-by: Yong Bakos <[email protected]>
> ---
>  src/scanner.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/scanner.c b/src/scanner.c
> index c927275..0a348e5 100644
> --- a/src/scanner.c
> +++ b/src/scanner.c
> @@ -586,7 +586,7 @@ free_interface(struct interface *interface)
>   *
>   * Upon error, this routine does not modify or set errno.
>   *
> - * \returns -1 on error, or a non-negative integer on success
> + * \return -1 on error, or a non-negative integer on success
>   */
>  static int
>  strtouint(const char *str)

this block isn't even a doxygen block (missing the /**), and it's a static
too. So I think dropping the \ is the better option here, especially given
that there's no other doxygen bit in this file.

Cheers,
   Peter
_______________________________________________
wayland-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/wayland-devel

Reply via email to