Re: [PATCH] PM / devfreq: kernel-doc typo corrections

Randy Dunlap
2012-10-11T18:22:34Z

On 10/11/2012 06:39 AM, Nishanth Menon wrote:

> Parameter documentation needs a ':' for scripts/kernel-doc
> to parse properly.
>
> Minor fixes for ones warned by:
> ./scripts/kernel-doc -text drivers/devfreq/devfreq.c>/dev/null
>
> Cc: "Rafael J. Wysocki" <rjw@sisk.pl>
> Cc: Kevin Hilman <khilman@ti.com>
> Cc: MyungJoo Ham <myungjoo.ham@samsung.com>
> Cc: Kyungmin Park <kyungmin.park@samsung.com>
> Cc: linux-kernel@vger.kernel.org
> Cc: linux-pm@vger.kernel.org
>
> Signed-off-by: Nishanth Menon <nm@ti.com>

Acked-by: Randy Dunlap <rdunlap@xenotime.net>

Thanks.

> ---
> drivers/devfreq/devfreq.c | 22 +++++++++++-----------
> 1 file changed, 11 insertions(+), 11 deletions(-)
>
> diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
> index 70c31d4..e4d48d2 100644
> --- a/drivers/devfreq/devfreq.c
> +++ b/drivers/devfreq/devfreq.c
> @@ -123,9 +123,9 @@ int update_devfreq(struct devfreq *devfreq)
> /**
> * devfreq_notifier_call() - Notify that the device frequency requirements
> * has been changed out of devfreq framework.
> - * @nb the notifier_block (supposed to be devfreq->nb)
> - * @type not used
> - * @devp not used
> + * @nb: the notifier_block (supposed to be devfreq->nb)
> + * @type: not used
> + * @devp: not used
> *
> * Called by a notifier that uses devfreq->nb.
> */
> @@ -431,7 +431,7 @@ err_out:
>
> /**
> * devfreq_remove_device() - Remove devfreq feature from a device.
> - * @devfreq the devfreq instance to be removed
> + * @devfreq: the devfreq instance to be removed
> */
> int devfreq_remove_device(struct devfreq *devfreq)
> {
> @@ -641,9 +641,9 @@ module_exit(devfreq_exit);
> /**
> * devfreq_recommended_opp() - Helper function to get proper OPP for the
> * freq value given to target callback.
> - * @dev The devfreq user device. (parent of devfreq)
> - * @freq The frequency given to target function
> - * @flags Flags handed from devfreq framework.
> + * @dev: The devfreq user device. (parent of devfreq)
> + * @freq: The frequency given to target function
> + * @flags: Flags handed from devfreq framework.
> *
> */
> struct opp *devfreq_recommended_opp(struct device *dev, unsigned long *freq,
> @@ -674,8 +674,8 @@ struct opp *devfreq_recommended_opp(struct device *dev, unsigned long *freq,
> * devfreq_register_opp_notifier() - Helper function to get devfreq notified
> * for any changes in the OPP availability
> * changes
> - * @dev The devfreq user device. (parent of devfreq)
> - * @devfreq The devfreq object.
> + * @dev: The devfreq user device. (parent of devfreq)
> + * @devfreq: The devfreq object.
> */
> int devfreq_register_opp_notifier(struct device *dev, struct devfreq *devfreq)
> {
> @@ -690,8 +690,8 @@ int devfreq_register_opp_notifier(struct device *dev, struct devfreq *devfreq)
> * devfreq_unregister_opp_notifier() - Helper function to stop getting devfreq
> * notified for any changes in the OPP
> * availability changes anymore.
> - * @dev The devfreq user device. (parent of devfreq)
> - * @devfreq The devfreq object.
> + * @dev: The devfreq user device. (parent of devfreq)
> + * @devfreq: The devfreq object.
> *
> * At exit() callback of devfreq_dev_profile, this must be included if
> * devfreq_recommended_opp is used.

--
~Randy