Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

tools: gpio-utils: fix various kernel-doc warnings

Fix several problems in kernel-doc notation in gpio-utils.c.

gpio-utils.c:37: warning: Incorrect use of kernel-doc format: * gpiotools_request_line() - request gpio lines in a gpiochip
gpio-utils.c:61: warning: expecting prototype for doc(). Prototype was for gpiotools_request_line() instead
gpio-utils.c:265: warning: Excess function parameter 'value' description in 'gpiotools_sets'
gpio-utils.c:1: warning: 'gpiotools_request_lines' not found

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Bartosz Golaszewski <bgolaszewski@baylibre.com>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: linux-gpio@vger.kernel.org
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

authored by

Randy Dunlap and committed by
Bartosz Golaszewski
b0922c07 4a5c9da4

+9 -9
+9 -9
tools/gpio/gpio-utils.c
··· 20 20 #define CONSUMER "gpio-utils" 21 21 22 22 /** 23 - * doc: Operation of gpio 23 + * DOC: Operation of gpio 24 24 * 25 25 * Provide the api of gpiochip for chardev interface. There are two 26 26 * types of api. The first one provide as same function as each ··· 100 100 } 101 101 102 102 /** 103 - * gpiotools_set_values(): Set the value of gpio(s) 103 + * gpiotools_set_values() - Set the value of gpio(s) 104 104 * @fd: The fd returned by 105 105 * gpiotools_request_line(). 106 106 * @values: The array of values want to set. ··· 124 124 } 125 125 126 126 /** 127 - * gpiotools_get_values(): Get the value of gpio(s) 127 + * gpiotools_get_values() - Get the value of gpio(s) 128 128 * @fd: The fd returned by 129 129 * gpiotools_request_line(). 130 130 * @values: The array of values get from hardware. ··· 148 148 } 149 149 150 150 /** 151 - * gpiotools_release_line(): Release the line(s) of gpiochip 151 + * gpiotools_release_line() - Release the line(s) of gpiochip 152 152 * @fd: The fd returned by 153 153 * gpiotools_request_line(). 154 154 * ··· 169 169 } 170 170 171 171 /** 172 - * gpiotools_get(): Get value from specific line 172 + * gpiotools_get() - Get value from specific line 173 173 * @device_name: The name of gpiochip without prefix "/dev/", 174 174 * such as "gpiochip0" 175 175 * @line: number of line, such as 2. ··· 191 191 192 192 193 193 /** 194 - * gpiotools_gets(): Get values from specific lines. 194 + * gpiotools_gets() - Get values from specific lines. 195 195 * @device_name: The name of gpiochip without prefix "/dev/", 196 196 * such as "gpiochip0". 197 197 * @lines: An array desired lines, specified by offset ··· 230 230 } 231 231 232 232 /** 233 - * gpiotools_set(): Set value to specific line 233 + * gpiotools_set() - Set value to specific line 234 234 * @device_name: The name of gpiochip without prefix "/dev/", 235 235 * such as "gpiochip0" 236 236 * @line: number of line, such as 2. ··· 248 248 } 249 249 250 250 /** 251 - * gpiotools_sets(): Set values to specific lines. 251 + * gpiotools_sets() - Set values to specific lines. 252 252 * @device_name: The name of gpiochip without prefix "/dev/", 253 253 * such as "gpiochip0". 254 254 * @lines: An array desired lines, specified by offset 255 255 * index for the associated GPIO device. 256 256 * @num_lines: The number of lines to request. 257 - * @value: The array of values set to gpiochip, must be 257 + * @values: The array of values set to gpiochip, must be 258 258 * 0(low) or 1(high). 259 259 * 260 260 * Return: On success return 0;