Re: [PATCH] regulator: fix regulator/consumer.h kernel-doc warning

From: Liam Girdwood
Date: Mon Aug 08 2011 - 12:40:22 EST


On Wed, 2011-08-03 at 18:09 -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
>
> Fix kernel-doc warning about internal/private data by marking it
> as "private:" so that kernel-doc will ignore it.
>
> Warning(include/linux/regulator/consumer.h:128): No description found for parameter 'ret'
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
> ---
> include/linux/regulator/consumer.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- linux-3.0-git18.orig/include/linux/regulator/consumer.h
> +++ linux-3.0-git18/include/linux/regulator/consumer.h
> @@ -123,7 +123,7 @@ struct regulator_bulk_data {
> const char *supply;
> struct regulator *consumer;
>
> - /* Internal use */
> + /* private: Internal use */
> int ret;
> };

Applied.

Thanks

Liam

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/