[PATCH 1/1] rapidio: fix kerneldoc for rio_mem_ops

[PATCH 1/1] rapidio: fix kerneldoc for rio_mem_ops

[Jiri Slaby]

Add structure name to the kerneldoc comment, so that we won't get
a kdoc error:
Error(include/linux/rio.h:336): cannot understand prototype: 'struct rio_mem_ops '

Signed-off-by: Jiri Slaby <jirislaby@gmail.com>
---
 include/linux/rio.h |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/include/linux/rio.h b/include/linux/rio.h
index dd61538..9710506 100644
--- a/include/linux/rio.h
+++ b/include/linux/rio.h
@@ -327,7 +327,7 @@ extern struct resource rio_resource;
 #define release_rio_region(start, n) __release_region(&rio_resource, (start), (n))
 
 /**
- * Struct for RIO memory definition.
+ * struct rio_mem_ops - struct for RIO memory definition.
  * @map_inb: The function for mapping inbound memory window.
  * @map_outb: The function for mapping outbound memory window.
  * @unmap_inb: The function for unmapping inbound memory window.
-- 
1.6.3

Re: [PATCH 1/1] rapidio: fix kerneldoc for rio_mem_ops

[Randy Dunlap]

Jiri Slaby wrote:
> Add structure name to the kerneldoc comment, so that we won't get
> a kdoc error:
> Error(include/linux/rio.h:336): cannot understand prototype: 'struct rio_mem_ops '
> 
> Signed-off-by: Jiri Slaby <jirislaby@gmail.com>

Acked-by: Randy Dunlap <randy.dunlap@oracle.com>

Thanks.

> ---
>  include/linux/rio.h |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
> 
> diff --git a/include/linux/rio.h b/include/linux/rio.h
> index dd61538..9710506 100644
> --- a/include/linux/rio.h
> +++ b/include/linux/rio.h
> @@ -327,7 +327,7 @@ extern struct resource rio_resource;
>  #define release_rio_region(start, n) __release_region(&rio_resource, (start), (n))
>  
>  /**
> - * Struct for RIO memory definition.
> + * struct rio_mem_ops - struct for RIO memory definition.
>   * @map_inb: The function for mapping inbound memory window.
>   * @map_outb: The function for mapping outbound memory window.
>   * @unmap_inb: The function for unmapping inbound memory window.


-- 
~Randy
LPC 2009, Sept. 23-25, Portland, Oregon
http://linuxplumbersconf.org/2009/