of: irq: fix of_irq_get[_byname]() kernel-doc
authorSergei Shtylyov <sergei.shtylyov@cogentembedded.com>
Sat, 28 May 2016 20:02:50 +0000 (23:02 +0300)
committerRob Herring <robh@kernel.org>
Fri, 3 Jun 2016 12:22:01 +0000 (07:22 -0500)
commit3993546646baf1dab5f5c4f7d9bb58f2046fd1c1
tree3508a9a3d4d0b0e8dd7357abf9abbdac49c7b63f
parentfcdec35e54dc8a7659f59482e23aad1fe9c3ef5a
of: irq: fix of_irq_get[_byname]() kernel-doc

The kernel-doc for the of_irq_get[_byname]()  is clearly inadequate in
describing the return values -- of_irq_get_byname() is documented better
than of_irq_get() but it  still doesn't mention that 0 is returned iff
irq_create_of_mapping() fails (it doesn't return an error code in this
case). Document all possible return value variants, making the writing
of the word "IRQ" consistent, while at it...

Fixes: 9ec36cafe43b ("of/irq: do irq resolution in platform_get_irq")
Fixes: ad69674e73a1 ("of/irq: do irq resolution in platform_get_irq_byname()")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
CC: stable@vger.kernel.org
Signed-off-by: Rob Herring <robh@kernel.org>
drivers/of/irq.c