On Thursday 03 July 2008, Henrique de Moraes Holschuh wrote: > Improve rfkill_toggle_radio's kernel-doc header a bit. > > Signed-off-by: Henrique de Moraes Holschuh <hmh@xxxxxxxxxx> > Cc: Ivo van Doorn <IvDoorn@xxxxxxxxx> Acked-by: Ivo van Doorn <IvDoorn@xxxxxxxxx> > --- > net/rfkill/rfkill.c | 12 +++++++----- > 1 files changed, 7 insertions(+), 5 deletions(-) > > diff --git a/net/rfkill/rfkill.c b/net/rfkill/rfkill.c > index ce0e231..aa7039d 100644 > --- a/net/rfkill/rfkill.c > +++ b/net/rfkill/rfkill.c > @@ -130,17 +130,19 @@ static void update_rfkill_state(struct rfkill *rfkill) > > /** > * rfkill_toggle_radio - wrapper for toggle_radio hook > - * calls toggle_radio taking into account a lot of "small" > - * details. > + * > * @rfkill: the rfkill struct to use > * @force: calls toggle_radio even if cache says it is not needed, > * and also makes sure notifications of the state will be > * sent even if it didn't change > * @state: the new state to call toggle_radio() with > * > - * This wrappen protects and enforces the API for toggle_radio > - * calls. Note that @force cannot override a (possibly cached) > - * state of RFKILL_STATE_HARD_BLOCKED. Any device making use of > + * Calls rfkill->toggle_radio, enforcing the API for toggle_radio > + * calls and handling all the red tape such as issuing notifications > + * if the call is successful. > + * > + * Note that @force cannot override a (possibly cached) state of > + * RFKILL_STATE_HARD_BLOCKED. Any device making use of > * RFKILL_STATE_HARD_BLOCKED implements either get_state() or > * rfkill_force_state(), so the cache either is bypassed or valid. > * -- To unsubscribe from this list: send the line "unsubscribe linux-wireless" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
