diff options
author | Mark Brown <broonie@opensource.wolfsonmicro.com> | 2009-01-01 07:18:17 -0500 |
---|---|---|
committer | Mark Brown <broonie@opensource.wolfsonmicro.com> | 2009-01-01 07:18:17 -0500 |
commit | ac11a2b35cc25c77d28218aaf60e7f7c6c7ee5d3 (patch) | |
tree | 705f28540115971f5253996fb71a4a4c8d963b0a | |
parent | 9bef6489d72abd8f598aede92be3854a69324c50 (diff) |
ASoC: Clean up kerneldoc warnings
Almost all parameters that have been misnamed in the comments.
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
-rw-r--r-- | sound/soc/soc-core.c | 46 | ||||
-rw-r--r-- | sound/soc/soc-dapm.c | 10 |
2 files changed, 29 insertions, 27 deletions
diff --git a/sound/soc/soc-core.c b/sound/soc/soc-core.c index b098c0b4c584..f73c1341437c 100644 --- a/sound/soc/soc-core.c +++ b/sound/soc/soc-core.c | |||
@@ -1300,6 +1300,8 @@ EXPORT_SYMBOL_GPL(snd_soc_test_bits); | |||
1300 | /** | 1300 | /** |
1301 | * snd_soc_new_pcms - create new sound card and pcms | 1301 | * snd_soc_new_pcms - create new sound card and pcms |
1302 | * @socdev: the SoC audio device | 1302 | * @socdev: the SoC audio device |
1303 | * @idx: ALSA card index | ||
1304 | * @xid: card identification | ||
1303 | * | 1305 | * |
1304 | * Create a new sound card based upon the codec and interface pcms. | 1306 | * Create a new sound card based upon the codec and interface pcms. |
1305 | * | 1307 | * |
@@ -1472,7 +1474,7 @@ EXPORT_SYMBOL_GPL(snd_soc_set_runtime_hwparams); | |||
1472 | * snd_soc_cnew - create new control | 1474 | * snd_soc_cnew - create new control |
1473 | * @_template: control template | 1475 | * @_template: control template |
1474 | * @data: control private data | 1476 | * @data: control private data |
1475 | * @lnng_name: control long name | 1477 | * @long_name: control long name |
1476 | * | 1478 | * |
1477 | * Create a new mixer control from a template control. | 1479 | * Create a new mixer control from a template control. |
1478 | * | 1480 | * |
@@ -1522,7 +1524,7 @@ EXPORT_SYMBOL_GPL(snd_soc_info_enum_double); | |||
1522 | /** | 1524 | /** |
1523 | * snd_soc_get_enum_double - enumerated double mixer get callback | 1525 | * snd_soc_get_enum_double - enumerated double mixer get callback |
1524 | * @kcontrol: mixer control | 1526 | * @kcontrol: mixer control |
1525 | * @uinfo: control element information | 1527 | * @ucontrol: control element information |
1526 | * | 1528 | * |
1527 | * Callback to get the value of a double enumerated mixer. | 1529 | * Callback to get the value of a double enumerated mixer. |
1528 | * | 1530 | * |
@@ -1551,7 +1553,7 @@ EXPORT_SYMBOL_GPL(snd_soc_get_enum_double); | |||
1551 | /** | 1553 | /** |
1552 | * snd_soc_put_enum_double - enumerated double mixer put callback | 1554 | * snd_soc_put_enum_double - enumerated double mixer put callback |
1553 | * @kcontrol: mixer control | 1555 | * @kcontrol: mixer control |
1554 | * @uinfo: control element information | 1556 | * @ucontrol: control element information |
1555 | * | 1557 | * |
1556 | * Callback to set the value of a double enumerated mixer. | 1558 | * Callback to set the value of a double enumerated mixer. |
1557 | * | 1559 | * |
@@ -1668,7 +1670,7 @@ EXPORT_SYMBOL_GPL(snd_soc_info_volsw); | |||
1668 | /** | 1670 | /** |
1669 | * snd_soc_get_volsw - single mixer get callback | 1671 | * snd_soc_get_volsw - single mixer get callback |
1670 | * @kcontrol: mixer control | 1672 | * @kcontrol: mixer control |
1671 | * @uinfo: control element information | 1673 | * @ucontrol: control element information |
1672 | * | 1674 | * |
1673 | * Callback to get the value of a single mixer control. | 1675 | * Callback to get the value of a single mixer control. |
1674 | * | 1676 | * |
@@ -1707,7 +1709,7 @@ EXPORT_SYMBOL_GPL(snd_soc_get_volsw); | |||
1707 | /** | 1709 | /** |
1708 | * snd_soc_put_volsw - single mixer put callback | 1710 | * snd_soc_put_volsw - single mixer put callback |
1709 | * @kcontrol: mixer control | 1711 | * @kcontrol: mixer control |
1710 | * @uinfo: control element information | 1712 | * @ucontrol: control element information |
1711 | * | 1713 | * |
1712 | * Callback to set the value of a single mixer control. | 1714 | * Callback to set the value of a single mixer control. |
1713 | * | 1715 | * |
@@ -1775,7 +1777,7 @@ EXPORT_SYMBOL_GPL(snd_soc_info_volsw_2r); | |||
1775 | /** | 1777 | /** |
1776 | * snd_soc_get_volsw_2r - double mixer get callback | 1778 | * snd_soc_get_volsw_2r - double mixer get callback |
1777 | * @kcontrol: mixer control | 1779 | * @kcontrol: mixer control |
1778 | * @uinfo: control element information | 1780 | * @ucontrol: control element information |
1779 | * | 1781 | * |
1780 | * Callback to get the value of a double mixer control that spans 2 registers. | 1782 | * Callback to get the value of a double mixer control that spans 2 registers. |
1781 | * | 1783 | * |
@@ -1812,7 +1814,7 @@ EXPORT_SYMBOL_GPL(snd_soc_get_volsw_2r); | |||
1812 | /** | 1814 | /** |
1813 | * snd_soc_put_volsw_2r - double mixer set callback | 1815 | * snd_soc_put_volsw_2r - double mixer set callback |
1814 | * @kcontrol: mixer control | 1816 | * @kcontrol: mixer control |
1815 | * @uinfo: control element information | 1817 | * @ucontrol: control element information |
1816 | * | 1818 | * |
1817 | * Callback to set the value of a double mixer control that spans 2 registers. | 1819 | * Callback to set the value of a double mixer control that spans 2 registers. |
1818 | * | 1820 | * |
@@ -1882,7 +1884,7 @@ EXPORT_SYMBOL_GPL(snd_soc_info_volsw_s8); | |||
1882 | /** | 1884 | /** |
1883 | * snd_soc_get_volsw_s8 - signed mixer get callback | 1885 | * snd_soc_get_volsw_s8 - signed mixer get callback |
1884 | * @kcontrol: mixer control | 1886 | * @kcontrol: mixer control |
1885 | * @uinfo: control element information | 1887 | * @ucontrol: control element information |
1886 | * | 1888 | * |
1887 | * Callback to get the value of a signed mixer control. | 1889 | * Callback to get the value of a signed mixer control. |
1888 | * | 1890 | * |
@@ -1909,7 +1911,7 @@ EXPORT_SYMBOL_GPL(snd_soc_get_volsw_s8); | |||
1909 | /** | 1911 | /** |
1910 | * snd_soc_put_volsw_sgn - signed mixer put callback | 1912 | * snd_soc_put_volsw_sgn - signed mixer put callback |
1911 | * @kcontrol: mixer control | 1913 | * @kcontrol: mixer control |
1912 | * @uinfo: control element information | 1914 | * @ucontrol: control element information |
1913 | * | 1915 | * |
1914 | * Callback to set the value of a signed mixer control. | 1916 | * Callback to set the value of a signed mixer control. |
1915 | * | 1917 | * |
@@ -1954,7 +1956,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dai_set_sysclk); | |||
1954 | /** | 1956 | /** |
1955 | * snd_soc_dai_set_clkdiv - configure DAI clock dividers. | 1957 | * snd_soc_dai_set_clkdiv - configure DAI clock dividers. |
1956 | * @dai: DAI | 1958 | * @dai: DAI |
1957 | * @clk_id: DAI specific clock divider ID | 1959 | * @div_id: DAI specific clock divider ID |
1958 | * @div: new clock divisor. | 1960 | * @div: new clock divisor. |
1959 | * | 1961 | * |
1960 | * Configures the clock dividers. This is used to derive the best DAI bit and | 1962 | * Configures the clock dividers. This is used to derive the best DAI bit and |
@@ -2060,7 +2062,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dai_digital_mute); | |||
2060 | /** | 2062 | /** |
2061 | * snd_soc_register_card - Register a card with the ASoC core | 2063 | * snd_soc_register_card - Register a card with the ASoC core |
2062 | * | 2064 | * |
2063 | * @param card Card to register | 2065 | * @card: Card to register |
2064 | * | 2066 | * |
2065 | * Note that currently this is an internal only function: it will be | 2067 | * Note that currently this is an internal only function: it will be |
2066 | * exposed to machine drivers after further backporting of ASoC v2 | 2068 | * exposed to machine drivers after further backporting of ASoC v2 |
@@ -2087,7 +2089,7 @@ static int snd_soc_register_card(struct snd_soc_card *card) | |||
2087 | /** | 2089 | /** |
2088 | * snd_soc_unregister_card - Unregister a card with the ASoC core | 2090 | * snd_soc_unregister_card - Unregister a card with the ASoC core |
2089 | * | 2091 | * |
2090 | * @param card Card to unregister | 2092 | * @card: Card to unregister |
2091 | * | 2093 | * |
2092 | * Note that currently this is an internal only function: it will be | 2094 | * Note that currently this is an internal only function: it will be |
2093 | * exposed to machine drivers after further backporting of ASoC v2 | 2095 | * exposed to machine drivers after further backporting of ASoC v2 |
@@ -2107,7 +2109,7 @@ static int snd_soc_unregister_card(struct snd_soc_card *card) | |||
2107 | /** | 2109 | /** |
2108 | * snd_soc_register_dai - Register a DAI with the ASoC core | 2110 | * snd_soc_register_dai - Register a DAI with the ASoC core |
2109 | * | 2111 | * |
2110 | * @param dai DAI to register | 2112 | * @dai: DAI to register |
2111 | */ | 2113 | */ |
2112 | int snd_soc_register_dai(struct snd_soc_dai *dai) | 2114 | int snd_soc_register_dai(struct snd_soc_dai *dai) |
2113 | { | 2115 | { |
@@ -2134,7 +2136,7 @@ EXPORT_SYMBOL_GPL(snd_soc_register_dai); | |||
2134 | /** | 2136 | /** |
2135 | * snd_soc_unregister_dai - Unregister a DAI from the ASoC core | 2137 | * snd_soc_unregister_dai - Unregister a DAI from the ASoC core |
2136 | * | 2138 | * |
2137 | * @param dai DAI to unregister | 2139 | * @dai: DAI to unregister |
2138 | */ | 2140 | */ |
2139 | void snd_soc_unregister_dai(struct snd_soc_dai *dai) | 2141 | void snd_soc_unregister_dai(struct snd_soc_dai *dai) |
2140 | { | 2142 | { |
@@ -2149,8 +2151,8 @@ EXPORT_SYMBOL_GPL(snd_soc_unregister_dai); | |||
2149 | /** | 2151 | /** |
2150 | * snd_soc_register_dais - Register multiple DAIs with the ASoC core | 2152 | * snd_soc_register_dais - Register multiple DAIs with the ASoC core |
2151 | * | 2153 | * |
2152 | * @param dai Array of DAIs to register | 2154 | * @dai: Array of DAIs to register |
2153 | * @param count Number of DAIs | 2155 | * @count: Number of DAIs |
2154 | */ | 2156 | */ |
2155 | int snd_soc_register_dais(struct snd_soc_dai *dai, size_t count) | 2157 | int snd_soc_register_dais(struct snd_soc_dai *dai, size_t count) |
2156 | { | 2158 | { |
@@ -2175,8 +2177,8 @@ EXPORT_SYMBOL_GPL(snd_soc_register_dais); | |||
2175 | /** | 2177 | /** |
2176 | * snd_soc_unregister_dais - Unregister multiple DAIs from the ASoC core | 2178 | * snd_soc_unregister_dais - Unregister multiple DAIs from the ASoC core |
2177 | * | 2179 | * |
2178 | * @param dai Array of DAIs to unregister | 2180 | * @dai: Array of DAIs to unregister |
2179 | * @param count Number of DAIs | 2181 | * @count: Number of DAIs |
2180 | */ | 2182 | */ |
2181 | void snd_soc_unregister_dais(struct snd_soc_dai *dai, size_t count) | 2183 | void snd_soc_unregister_dais(struct snd_soc_dai *dai, size_t count) |
2182 | { | 2184 | { |
@@ -2190,7 +2192,7 @@ EXPORT_SYMBOL_GPL(snd_soc_unregister_dais); | |||
2190 | /** | 2192 | /** |
2191 | * snd_soc_register_platform - Register a platform with the ASoC core | 2193 | * snd_soc_register_platform - Register a platform with the ASoC core |
2192 | * | 2194 | * |
2193 | * @param platform platform to register | 2195 | * @platform: platform to register |
2194 | */ | 2196 | */ |
2195 | int snd_soc_register_platform(struct snd_soc_platform *platform) | 2197 | int snd_soc_register_platform(struct snd_soc_platform *platform) |
2196 | { | 2198 | { |
@@ -2213,7 +2215,7 @@ EXPORT_SYMBOL_GPL(snd_soc_register_platform); | |||
2213 | /** | 2215 | /** |
2214 | * snd_soc_unregister_platform - Unregister a platform from the ASoC core | 2216 | * snd_soc_unregister_platform - Unregister a platform from the ASoC core |
2215 | * | 2217 | * |
2216 | * @param platform platform to unregister | 2218 | * @platform: platform to unregister |
2217 | */ | 2219 | */ |
2218 | void snd_soc_unregister_platform(struct snd_soc_platform *platform) | 2220 | void snd_soc_unregister_platform(struct snd_soc_platform *platform) |
2219 | { | 2221 | { |
@@ -2228,7 +2230,7 @@ EXPORT_SYMBOL_GPL(snd_soc_unregister_platform); | |||
2228 | /** | 2230 | /** |
2229 | * snd_soc_register_codec - Register a codec with the ASoC core | 2231 | * snd_soc_register_codec - Register a codec with the ASoC core |
2230 | * | 2232 | * |
2231 | * @param codec codec to register | 2233 | * @codec: codec to register |
2232 | */ | 2234 | */ |
2233 | int snd_soc_register_codec(struct snd_soc_codec *codec) | 2235 | int snd_soc_register_codec(struct snd_soc_codec *codec) |
2234 | { | 2236 | { |
@@ -2255,7 +2257,7 @@ EXPORT_SYMBOL_GPL(snd_soc_register_codec); | |||
2255 | /** | 2257 | /** |
2256 | * snd_soc_unregister_codec - Unregister a codec from the ASoC core | 2258 | * snd_soc_unregister_codec - Unregister a codec from the ASoC core |
2257 | * | 2259 | * |
2258 | * @param codec codec to unregister | 2260 | * @codec: codec to unregister |
2259 | */ | 2261 | */ |
2260 | void snd_soc_unregister_codec(struct snd_soc_codec *codec) | 2262 | void snd_soc_unregister_codec(struct snd_soc_codec *codec) |
2261 | { | 2263 | { |
diff --git a/sound/soc/soc-dapm.c b/sound/soc/soc-dapm.c index 8863eddbac02..6c79ca6df0bf 100644 --- a/sound/soc/soc-dapm.c +++ b/sound/soc/soc-dapm.c | |||
@@ -1077,7 +1077,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dapm_new_widgets); | |||
1077 | /** | 1077 | /** |
1078 | * snd_soc_dapm_get_volsw - dapm mixer get callback | 1078 | * snd_soc_dapm_get_volsw - dapm mixer get callback |
1079 | * @kcontrol: mixer control | 1079 | * @kcontrol: mixer control |
1080 | * @uinfo: control element information | 1080 | * @ucontrol: control element information |
1081 | * | 1081 | * |
1082 | * Callback to get the value of a dapm mixer control. | 1082 | * Callback to get the value of a dapm mixer control. |
1083 | * | 1083 | * |
@@ -1122,7 +1122,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dapm_get_volsw); | |||
1122 | /** | 1122 | /** |
1123 | * snd_soc_dapm_put_volsw - dapm mixer set callback | 1123 | * snd_soc_dapm_put_volsw - dapm mixer set callback |
1124 | * @kcontrol: mixer control | 1124 | * @kcontrol: mixer control |
1125 | * @uinfo: control element information | 1125 | * @ucontrol: control element information |
1126 | * | 1126 | * |
1127 | * Callback to set the value of a dapm mixer control. | 1127 | * Callback to set the value of a dapm mixer control. |
1128 | * | 1128 | * |
@@ -1193,7 +1193,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dapm_put_volsw); | |||
1193 | /** | 1193 | /** |
1194 | * snd_soc_dapm_get_enum_double - dapm enumerated double mixer get callback | 1194 | * snd_soc_dapm_get_enum_double - dapm enumerated double mixer get callback |
1195 | * @kcontrol: mixer control | 1195 | * @kcontrol: mixer control |
1196 | * @uinfo: control element information | 1196 | * @ucontrol: control element information |
1197 | * | 1197 | * |
1198 | * Callback to get the value of a dapm enumerated double mixer control. | 1198 | * Callback to get the value of a dapm enumerated double mixer control. |
1199 | * | 1199 | * |
@@ -1221,7 +1221,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dapm_get_enum_double); | |||
1221 | /** | 1221 | /** |
1222 | * snd_soc_dapm_put_enum_double - dapm enumerated double mixer set callback | 1222 | * snd_soc_dapm_put_enum_double - dapm enumerated double mixer set callback |
1223 | * @kcontrol: mixer control | 1223 | * @kcontrol: mixer control |
1224 | * @uinfo: control element information | 1224 | * @ucontrol: control element information |
1225 | * | 1225 | * |
1226 | * Callback to set the value of a dapm enumerated double mixer control. | 1226 | * Callback to set the value of a dapm enumerated double mixer control. |
1227 | * | 1227 | * |
@@ -1419,7 +1419,7 @@ int snd_soc_dapm_set_bias_level(struct snd_soc_device *socdev, | |||
1419 | 1419 | ||
1420 | /** | 1420 | /** |
1421 | * snd_soc_dapm_enable_pin - enable pin. | 1421 | * snd_soc_dapm_enable_pin - enable pin. |
1422 | * @snd_soc_codec: SoC codec | 1422 | * @codec: SoC codec |
1423 | * @pin: pin name | 1423 | * @pin: pin name |
1424 | * | 1424 | * |
1425 | * Enables input/output pin and it's parents or children widgets iff there is | 1425 | * Enables input/output pin and it's parents or children widgets iff there is |