On 08/26/2012 04:47 AM, Robert P. J. Day wrote:
>
> Fix *obvious* errors in current kerneldoc in both hsi.h and hsi.c,
> including that a comment in the middle of the structure seems to screw
> up kerneldoc processing. I didn't know that.
FYI, scripts/kernel-doc supports using
/* private: */
and
/* public: */
to mark fields of a struct that the owner/maintainer wishes
to retain as private fields, undocumented, generally not to be
used/touched by common drivers, just used by the core code.
In this case it does appear that the /* private: */ line might
as well be deleted since the fields are documented.
Thanks.
>
> Signed-off-by: Robert P. J. Day <rpjday@xxxxxxxxxxxxxx>
>
> ---
>
> diff --git a/drivers/hsi/hsi.c b/drivers/hsi/hsi.c
> index 2d58f93..833dd1a 100644
> --- a/drivers/hsi/hsi.c
> +++ b/drivers/hsi/hsi.c
> @@ -420,7 +420,7 @@ static int hsi_event_notifier_call(struct notifier_block *nb,
> /**
> * hsi_register_port_event - Register a client to receive port events
> * @cl: HSI client that wants to receive port events
> - * @cb: Event handler callback
> + * @handler: Event handler callback
> *
> * Clients should register a callback to be able to receive
> * events from the ports. Registration should happen after
> diff --git a/include/linux/hsi/hsi.h b/include/linux/hsi/hsi.h
> index 56fae86..e4f3d61 100644
> --- a/include/linux/hsi/hsi.h
> +++ b/include/linux/hsi/hsi.h
> @@ -121,7 +121,7 @@ static inline int hsi_register_board_info(struct hsi_board_info const *info,
> * @device: Driver model representation of the device
> * @tx_cfg: HSI TX configuration
> * @rx_cfg: HSI RX configuration
> - * @e_handler: Callback for handling port events (RX Wake High/Low)
> + * @ehandler: Callback for handling port events (RX Wake High/Low)
> * @pclaimed: Keeps tracks if the clients claimed its associated HSI port
> * @nb: Notifier block for port events
> */
> @@ -129,7 +129,6 @@ struct hsi_client {
> struct device device;
> struct hsi_config tx_cfg;
> struct hsi_config rx_cfg;
> - /* private: */
> void (*ehandler)(struct hsi_client *, unsigned long);
> unsigned int pclaimed:1;
> struct notifier_block nb;
>
--
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
