diff options
author | MyungJoo Ham <myungjoo.ham@samsung.com> | 2012-11-20 05:22:33 -0500 |
---|---|---|
committer | MyungJoo Ham <myungjoo.ham@samsung.com> | 2012-11-21 23:43:27 -0500 |
commit | df072eb97dcfb819390227649f6b7c07a90aa2df (patch) | |
tree | 10380d13af75f2998a1d49062de668ec84604c75 /include/linux/extcon.h | |
parent | 3bf742ffd48e7d1cea864741a123203207b33b80 (diff) |
extcon: kernel_doc style fix
Corrected kernel_doc entries.
Signed-off-by: MyungJoo Ham <myungjoo.ham@samsung.com>
Diffstat (limited to 'include/linux/extcon.h')
-rw-r--r-- | include/linux/extcon.h | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/include/linux/extcon.h b/include/linux/extcon.h index 54c00ce9ce7a..fcb51c88319f 100644 --- a/include/linux/extcon.h +++ b/include/linux/extcon.h | |||
@@ -76,12 +76,12 @@ struct extcon_cable; | |||
76 | 76 | ||
77 | /** | 77 | /** |
78 | * struct extcon_dev - An extcon device represents one external connector. | 78 | * struct extcon_dev - An extcon device represents one external connector. |
79 | * @name The name of this extcon device. Parent device name is used | 79 | * @name: The name of this extcon device. Parent device name is used |
80 | * if NULL. | 80 | * if NULL. |
81 | * @supported_cable Array of supported cable names ending with NULL. | 81 | * @supported_cable: Array of supported cable names ending with NULL. |
82 | * If supported_cable is NULL, cable name related APIs | 82 | * If supported_cable is NULL, cable name related APIs |
83 | * are disabled. | 83 | * are disabled. |
84 | * @mutually_exclusive Array of mutually exclusive set of cables that cannot | 84 | * @mutually_exclusive: Array of mutually exclusive set of cables that cannot |
85 | * be attached simultaneously. The array should be | 85 | * be attached simultaneously. The array should be |
86 | * ending with NULL or be NULL (no mutually exclusive | 86 | * ending with NULL or be NULL (no mutually exclusive |
87 | * cables). For example, if it is { 0x7, 0x30, 0}, then, | 87 | * cables). For example, if it is { 0x7, 0x30, 0}, then, |
@@ -89,21 +89,21 @@ struct extcon_cable; | |||
89 | * be attached simulataneously. {0x7, 0} is equivalent to | 89 | * be attached simulataneously. {0x7, 0} is equivalent to |
90 | * {0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there | 90 | * {0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there |
91 | * can be no simultaneous connections. | 91 | * can be no simultaneous connections. |
92 | * @print_name An optional callback to override the method to print the | 92 | * @print_name: An optional callback to override the method to print the |
93 | * name of the extcon device. | 93 | * name of the extcon device. |
94 | * @print_state An optional callback to override the method to print the | 94 | * @print_state: An optional callback to override the method to print the |
95 | * status of the extcon device. | 95 | * status of the extcon device. |
96 | * @dev Device of this extcon. Do not provide at register-time. | 96 | * @dev: Device of this extcon. Do not provide at register-time. |
97 | * @state Attach/detach state of this extcon. Do not provide at | 97 | * @state: Attach/detach state of this extcon. Do not provide at |
98 | * register-time | 98 | * register-time |
99 | * @nh Notifier for the state change events from this extcon | 99 | * @nh: Notifier for the state change events from this extcon |
100 | * @entry To support list of extcon devices so that users can search | 100 | * @entry: To support list of extcon devices so that users can search |
101 | * for extcon devices based on the extcon name. | 101 | * for extcon devices based on the extcon name. |
102 | * @lock | 102 | * @lock: |
103 | * @max_supported Internal value to store the number of cables. | 103 | * @max_supported: Internal value to store the number of cables. |
104 | * @extcon_dev_type Device_type struct to provide attribute_groups | 104 | * @extcon_dev_type: Device_type struct to provide attribute_groups |
105 | * customized for each extcon device. | 105 | * customized for each extcon device. |
106 | * @cables Sysfs subdirectories. Each represents one cable. | 106 | * @cables: Sysfs subdirectories. Each represents one cable. |
107 | * | 107 | * |
108 | * In most cases, users only need to provide "User initializing data" of | 108 | * In most cases, users only need to provide "User initializing data" of |
109 | * this struct when registering an extcon. In some exceptional cases, | 109 | * this struct when registering an extcon. In some exceptional cases, |
@@ -139,12 +139,12 @@ struct extcon_dev { | |||
139 | 139 | ||
140 | /** | 140 | /** |
141 | * struct extcon_cable - An internal data for each cable of extcon device. | 141 | * struct extcon_cable - An internal data for each cable of extcon device. |
142 | * @edev The extcon device | 142 | * @edev: The extcon device |
143 | * @cable_index Index of this cable in the edev | 143 | * @cable_index: Index of this cable in the edev |
144 | * @attr_g Attribute group for the cable | 144 | * @attr_g: Attribute group for the cable |
145 | * @attr_name "name" sysfs entry | 145 | * @attr_name: "name" sysfs entry |
146 | * @attr_state "state" sysfs entry | 146 | * @attr_state: "state" sysfs entry |
147 | * @attrs Array pointing to attr_name and attr_state for attr_g | 147 | * @attrs: Array pointing to attr_name and attr_state for attr_g |
148 | */ | 148 | */ |
149 | struct extcon_cable { | 149 | struct extcon_cable { |
150 | struct extcon_dev *edev; | 150 | struct extcon_dev *edev; |
@@ -160,11 +160,11 @@ struct extcon_cable { | |||
160 | /** | 160 | /** |
161 | * struct extcon_specific_cable_nb - An internal data for | 161 | * struct extcon_specific_cable_nb - An internal data for |
162 | * extcon_register_interest(). | 162 | * extcon_register_interest(). |
163 | * @internal_nb a notifier block bridging extcon notifier and cable notifier. | 163 | * @internal_nb: a notifier block bridging extcon notifier and cable notifier. |
164 | * @user_nb user provided notifier block for events from a specific cable. | 164 | * @user_nb: user provided notifier block for events from a specific cable. |
165 | * @cable_index the target cable. | 165 | * @cable_index: the target cable. |
166 | * @edev the target extcon device. | 166 | * @edev: the target extcon device. |
167 | * @previous_value the saved previous event value. | 167 | * @previous_value: the saved previous event value. |
168 | */ | 168 | */ |
169 | struct extcon_specific_cable_nb { | 169 | struct extcon_specific_cable_nb { |
170 | struct notifier_block internal_nb; | 170 | struct notifier_block internal_nb; |