[openib-general] Re: [PATCH 12/16] ehca: firmware InfiniBand interface

[Randy.Dunlap]

On Mon, 15 May 2006 19:42:49 +0200 Heiko J Schick wrote:

> Signed-off-by: Heiko J Schick <schickhj at de.ibm.com>
> 
> 
>   drivers/infiniband/hw/ehca/hcp_if.c | 1476 ++++++++++++++++++++++++++++++++++++
>   drivers/infiniband/hw/ehca/hcp_if.h |  330 ++++++++
>   2 files changed, 1806 insertions(+)
> 
> 
> 
> --- linux-2.6.17-rc2-orig/drivers/infiniband/hw/ehca/hcp_if.h	1970-01-01 01:00:00.000000000 +0100
> +++ linux-2.6.17-rc2/drivers/infiniband/hw/ehca/hcp_if.h	2006-05-12 12:48:21.000000000 +0200
> @@ -0,0 +1,330 @@

> +/**
> + * hipz_h_alloc_resource_eq - Allocate EQ resources in HW and FW, initalize
> + * resources, create the empty EQPT (ring).
> + *
> + * @eq_handle:         eq handle for this queue
> + * @act_nr_of_entries: actual number of queue entries
> + * @act_pages:         actual number of queue pages
> + * @eq_ist:            used by hcp_H_XIRR() call
> + */

kernel-doc format needs:
1.  a short function name + description on one line
2.  no blank line between function and parameters
3.  blank line (optional) before more detailed function description

See Documentation/kernel-doc-nano-HOWTO.txt or other kernel source
files for more info.
And please test it with "make htmldocs" or "make mandocs".

---
~Randy