IB/Verbs: Improve docs for rdma-helpers
authorMichael Wang <yun.wang@profitbricks.com>
Mon, 18 May 2015 08:41:45 +0000 (10:41 +0200)
committerDoug Ledford <dledford@redhat.com>
Mon, 18 May 2015 17:35:06 +0000 (13:35 -0400)
commit296ec00995fb28c4e34b41f80b5a876f3a25c134
tree98f94bb1df59b5ebbb36b69406e9f6726536a14a
parent227128fc68401d8e36b660ffeef4320c5fb492d7
IB/Verbs: Improve docs for rdma-helpers

Increase the level of documentation for the rdma_cap_* helpers
introduced by Michael Wang <yun.wang@profitbricks.com>.

This patch is loosely based on a patch Michael wrote to enhance the
documentation of these functions, but has been significantly modified
in terms of verbiage.  In addition, the comments were moved from a kernel
Documentation/infiniband/ file to being inline in the header file itself
for the functions in question.  Finally, the documentation was formated
in proper kdoc format.

Signed-off-by: Michael Wang <yun.wang@profitbricks.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
include/rdma/ib_verbs.h