include/hw/qdev-core.h: Correct and clarify gpio doc comments
authorPeter Maydell <peter.maydell@linaro.org>
Mon, 8 Jul 2024 15:33:12 +0000 (16:33 +0100)
committerPhilippe Mathieu-Daudé <philmd@linaro.org>
Tue, 16 Jul 2024 18:04:08 +0000 (20:04 +0200)
commit1ee5f645721832a1285157f6ee2a34cc549c30d2
treee5ec1aa31839e9e9854e1167308908e62d73513f
parent9a365c25362c0d6b4cc0a53f88aae22b7d2532c6
include/hw/qdev-core.h: Correct and clarify gpio doc comments

The doc comments for the functions for named GPIO inputs and
outputs had a couple of problems:
 * some copy-and-paste errors meant the qdev_connect_gpio_out_named()
   doc comment had references to input GPIOs that should be to
   output GPIOs
 * it wasn't very clear that named GPIOs are arrays and so the
   connect functions specify a single GPIO line by giving both
   the name of the array and the index within that array

Fix the copy-and-paste errors and slightly expand the text
to say that functions are connecting one line in a named GPIO
array, not a single named GPIO line.

Reported-by: BALATON Zoltan <balaton@eik.bme.hu>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Message-ID: <20240708153312.3109380-1-peter.maydell@linaro.org>
Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
include/hw/qdev-core.h