diff options
| author | Henrique de Moraes Holschuh <hmh@hmh.eng.br> | 2008-07-21 20:18:22 -0400 |
|---|---|---|
| committer | John W. Linville <linville@tuxdriver.com> | 2008-07-29 16:55:03 -0400 |
| commit | 435307a365ceedc4f4e1813e405f583f434d98e4 (patch) | |
| tree | 2f285547aba15a7235e46485ebde365d57cb378e /net/rfkill | |
| parent | 064af1117b4aa64a0e52f6b741df7356ef055142 (diff) | |
rfkill: yet more minor kernel-doc fixes
For some stupid reason, I sent and old version of the patch minor kernel
doc-fix patch, and it got merged before I noticed the problem. This is an
incremental fix on top.
Signed-off-by: Henrique de Moraes Holschuh <hmh@hmh.eng.br>
Acked-by: Ivo van Doorn <IvDoorn@gmail.com>
Signed-off-by: John W. Linville <linville@tuxdriver.com>
Diffstat (limited to 'net/rfkill')
| -rw-r--r-- | net/rfkill/rfkill.c | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/net/rfkill/rfkill.c b/net/rfkill/rfkill.c index ac205eceaf42..c6f2f388cb72 100644 --- a/net/rfkill/rfkill.c +++ b/net/rfkill/rfkill.c | |||
| @@ -130,7 +130,6 @@ static void update_rfkill_state(struct rfkill *rfkill) | |||
| 130 | 130 | ||
| 131 | /** | 131 | /** |
| 132 | * rfkill_toggle_radio - wrapper for toggle_radio hook | 132 | * rfkill_toggle_radio - wrapper for toggle_radio hook |
| 133 | * | ||
| 134 | * @rfkill: the rfkill struct to use | 133 | * @rfkill: the rfkill struct to use |
| 135 | * @force: calls toggle_radio even if cache says it is not needed, | 134 | * @force: calls toggle_radio even if cache says it is not needed, |
| 136 | * and also makes sure notifications of the state will be | 135 | * and also makes sure notifications of the state will be |
| @@ -141,8 +140,8 @@ static void update_rfkill_state(struct rfkill *rfkill) | |||
| 141 | * calls and handling all the red tape such as issuing notifications | 140 | * calls and handling all the red tape such as issuing notifications |
| 142 | * if the call is successful. | 141 | * if the call is successful. |
| 143 | * | 142 | * |
| 144 | * Note that @force cannot override a (possibly cached) state of | 143 | * Note that the @force parameter cannot override a (possibly cached) |
| 145 | * RFKILL_STATE_HARD_BLOCKED. Any device making use of | 144 | * state of RFKILL_STATE_HARD_BLOCKED. Any device making use of |
| 146 | * RFKILL_STATE_HARD_BLOCKED implements either get_state() or | 145 | * RFKILL_STATE_HARD_BLOCKED implements either get_state() or |
| 147 | * rfkill_force_state(), so the cache either is bypassed or valid. | 146 | * rfkill_force_state(), so the cache either is bypassed or valid. |
| 148 | * | 147 | * |
| @@ -200,12 +199,12 @@ static int rfkill_toggle_radio(struct rfkill *rfkill, | |||
| 200 | 199 | ||
| 201 | /** | 200 | /** |
| 202 | * rfkill_switch_all - Toggle state of all switches of given type | 201 | * rfkill_switch_all - Toggle state of all switches of given type |
| 203 | * @type: type of interfaces to be affeceted | 202 | * @type: type of interfaces to be affected |
| 204 | * @state: the new state | 203 | * @state: the new state |
| 205 | * | 204 | * |
| 206 | * This function toggles state of all switches of given type unless | 205 | * This function toggles the state of all switches of given type, |
| 207 | * a specific switch is claimed by userspace in which case it is | 206 | * unless a specific switch is claimed by userspace (in which case, |
| 208 | * left alone. | 207 | * that switch is left alone). |
| 209 | */ | 208 | */ |
| 210 | void rfkill_switch_all(enum rfkill_type type, enum rfkill_state state) | 209 | void rfkill_switch_all(enum rfkill_type type, enum rfkill_state state) |
| 211 | { | 210 | { |
| @@ -540,9 +539,10 @@ static void rfkill_remove_switch(struct rfkill *rfkill) | |||
| 540 | * @type: type of the switch (RFKILL_TYPE_*) | 539 | * @type: type of the switch (RFKILL_TYPE_*) |
| 541 | * | 540 | * |
| 542 | * This function should be called by the network driver when it needs | 541 | * This function should be called by the network driver when it needs |
| 543 | * rfkill structure. Once the structure is allocated the driver shoud | 542 | * rfkill structure. Once the structure is allocated the driver should |
| 544 | * finish its initialization by setting name, private data, enable_radio | 543 | * finish its initialization by setting the name, private data, enable_radio |
| 545 | * and disable_radio methods and then register it with rfkill_register(). | 544 | * and disable_radio methods and then register it with rfkill_register(). |
| 545 | * | ||
| 546 | * NOTE: If registration fails the structure shoudl be freed by calling | 546 | * NOTE: If registration fails the structure shoudl be freed by calling |
| 547 | * rfkill_free() otherwise rfkill_unregister() should be used. | 547 | * rfkill_free() otherwise rfkill_unregister() should be used. |
| 548 | */ | 548 | */ |
| @@ -574,7 +574,7 @@ EXPORT_SYMBOL(rfkill_allocate); | |||
| 574 | * rfkill_free - Mark rfkill structure for deletion | 574 | * rfkill_free - Mark rfkill structure for deletion |
| 575 | * @rfkill: rfkill structure to be destroyed | 575 | * @rfkill: rfkill structure to be destroyed |
| 576 | * | 576 | * |
| 577 | * Decrements reference count of rfkill structure so it is destroyed. | 577 | * Decrements reference count of the rfkill structure so it is destroyed. |
| 578 | * Note that rfkill_free() should _not_ be called after rfkill_unregister(). | 578 | * Note that rfkill_free() should _not_ be called after rfkill_unregister(). |
| 579 | */ | 579 | */ |
| 580 | void rfkill_free(struct rfkill *rfkill) | 580 | void rfkill_free(struct rfkill *rfkill) |
