Skip to content

Commit

Permalink
ASoC: Clean up kerneldoc warnings
Browse files Browse the repository at this point in the history
Almost all parameters that have been misnamed in the comments.

Signed-off-by: Mark Brown <[email protected]>
  • Loading branch information
broonie committed Jan 1, 2009
1 parent 9bef648 commit ac11a2b
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 27 deletions.
46 changes: 24 additions & 22 deletions sound/soc/soc-core.c
Original file line number Diff line number Diff line change
Expand Up @@ -1300,6 +1300,8 @@ EXPORT_SYMBOL_GPL(snd_soc_test_bits);
/**
* snd_soc_new_pcms - create new sound card and pcms
* @socdev: the SoC audio device
* @idx: ALSA card index
* @xid: card identification
*
* Create a new sound card based upon the codec and interface pcms.
*
Expand Down Expand Up @@ -1472,7 +1474,7 @@ EXPORT_SYMBOL_GPL(snd_soc_set_runtime_hwparams);
* snd_soc_cnew - create new control
* @_template: control template
* @data: control private data
* @lnng_name: control long name
* @long_name: control long name
*
* Create a new mixer control from a template control.
*
Expand Down Expand Up @@ -1522,7 +1524,7 @@ EXPORT_SYMBOL_GPL(snd_soc_info_enum_double);
/**
* snd_soc_get_enum_double - enumerated double mixer get callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to get the value of a double enumerated mixer.
*
Expand Down Expand Up @@ -1551,7 +1553,7 @@ EXPORT_SYMBOL_GPL(snd_soc_get_enum_double);
/**
* snd_soc_put_enum_double - enumerated double mixer put callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to set the value of a double enumerated mixer.
*
Expand Down Expand Up @@ -1668,7 +1670,7 @@ EXPORT_SYMBOL_GPL(snd_soc_info_volsw);
/**
* snd_soc_get_volsw - single mixer get callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to get the value of a single mixer control.
*
Expand Down Expand Up @@ -1707,7 +1709,7 @@ EXPORT_SYMBOL_GPL(snd_soc_get_volsw);
/**
* snd_soc_put_volsw - single mixer put callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to set the value of a single mixer control.
*
Expand Down Expand Up @@ -1775,7 +1777,7 @@ EXPORT_SYMBOL_GPL(snd_soc_info_volsw_2r);
/**
* snd_soc_get_volsw_2r - double mixer get callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to get the value of a double mixer control that spans 2 registers.
*
Expand Down Expand Up @@ -1812,7 +1814,7 @@ EXPORT_SYMBOL_GPL(snd_soc_get_volsw_2r);
/**
* snd_soc_put_volsw_2r - double mixer set callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to set the value of a double mixer control that spans 2 registers.
*
Expand Down Expand Up @@ -1882,7 +1884,7 @@ EXPORT_SYMBOL_GPL(snd_soc_info_volsw_s8);
/**
* snd_soc_get_volsw_s8 - signed mixer get callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to get the value of a signed mixer control.
*
Expand All @@ -1909,7 +1911,7 @@ EXPORT_SYMBOL_GPL(snd_soc_get_volsw_s8);
/**
* snd_soc_put_volsw_sgn - signed mixer put callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to set the value of a signed mixer control.
*
Expand Down Expand Up @@ -1954,7 +1956,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dai_set_sysclk);
/**
* snd_soc_dai_set_clkdiv - configure DAI clock dividers.
* @dai: DAI
* @clk_id: DAI specific clock divider ID
* @div_id: DAI specific clock divider ID
* @div: new clock divisor.
*
* Configures the clock dividers. This is used to derive the best DAI bit and
Expand Down Expand Up @@ -2060,7 +2062,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dai_digital_mute);
/**
* snd_soc_register_card - Register a card with the ASoC core
*
* @param card Card to register
* @card: Card to register
*
* Note that currently this is an internal only function: it will be
* exposed to machine drivers after further backporting of ASoC v2
Expand All @@ -2087,7 +2089,7 @@ static int snd_soc_register_card(struct snd_soc_card *card)
/**
* snd_soc_unregister_card - Unregister a card with the ASoC core
*
* @param card Card to unregister
* @card: Card to unregister
*
* Note that currently this is an internal only function: it will be
* exposed to machine drivers after further backporting of ASoC v2
Expand All @@ -2107,7 +2109,7 @@ static int snd_soc_unregister_card(struct snd_soc_card *card)
/**
* snd_soc_register_dai - Register a DAI with the ASoC core
*
* @param dai DAI to register
* @dai: DAI to register
*/
int snd_soc_register_dai(struct snd_soc_dai *dai)
{
Expand All @@ -2134,7 +2136,7 @@ EXPORT_SYMBOL_GPL(snd_soc_register_dai);
/**
* snd_soc_unregister_dai - Unregister a DAI from the ASoC core
*
* @param dai DAI to unregister
* @dai: DAI to unregister
*/
void snd_soc_unregister_dai(struct snd_soc_dai *dai)
{
Expand All @@ -2149,8 +2151,8 @@ EXPORT_SYMBOL_GPL(snd_soc_unregister_dai);
/**
* snd_soc_register_dais - Register multiple DAIs with the ASoC core
*
* @param dai Array of DAIs to register
* @param count Number of DAIs
* @dai: Array of DAIs to register
* @count: Number of DAIs
*/
int snd_soc_register_dais(struct snd_soc_dai *dai, size_t count)
{
Expand All @@ -2175,8 +2177,8 @@ EXPORT_SYMBOL_GPL(snd_soc_register_dais);
/**
* snd_soc_unregister_dais - Unregister multiple DAIs from the ASoC core
*
* @param dai Array of DAIs to unregister
* @param count Number of DAIs
* @dai: Array of DAIs to unregister
* @count: Number of DAIs
*/
void snd_soc_unregister_dais(struct snd_soc_dai *dai, size_t count)
{
Expand All @@ -2190,7 +2192,7 @@ EXPORT_SYMBOL_GPL(snd_soc_unregister_dais);
/**
* snd_soc_register_platform - Register a platform with the ASoC core
*
* @param platform platform to register
* @platform: platform to register
*/
int snd_soc_register_platform(struct snd_soc_platform *platform)
{
Expand All @@ -2213,7 +2215,7 @@ EXPORT_SYMBOL_GPL(snd_soc_register_platform);
/**
* snd_soc_unregister_platform - Unregister a platform from the ASoC core
*
* @param platform platform to unregister
* @platform: platform to unregister
*/
void snd_soc_unregister_platform(struct snd_soc_platform *platform)
{
Expand All @@ -2228,7 +2230,7 @@ EXPORT_SYMBOL_GPL(snd_soc_unregister_platform);
/**
* snd_soc_register_codec - Register a codec with the ASoC core
*
* @param codec codec to register
* @codec: codec to register
*/
int snd_soc_register_codec(struct snd_soc_codec *codec)
{
Expand All @@ -2255,7 +2257,7 @@ EXPORT_SYMBOL_GPL(snd_soc_register_codec);
/**
* snd_soc_unregister_codec - Unregister a codec from the ASoC core
*
* @param codec codec to unregister
* @codec: codec to unregister
*/
void snd_soc_unregister_codec(struct snd_soc_codec *codec)
{
Expand Down
10 changes: 5 additions & 5 deletions sound/soc/soc-dapm.c
Original file line number Diff line number Diff line change
Expand Up @@ -1077,7 +1077,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dapm_new_widgets);
/**
* snd_soc_dapm_get_volsw - dapm mixer get callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to get the value of a dapm mixer control.
*
Expand Down Expand Up @@ -1122,7 +1122,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dapm_get_volsw);
/**
* snd_soc_dapm_put_volsw - dapm mixer set callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to set the value of a dapm mixer control.
*
Expand Down Expand Up @@ -1193,7 +1193,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dapm_put_volsw);
/**
* snd_soc_dapm_get_enum_double - dapm enumerated double mixer get callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to get the value of a dapm enumerated double mixer control.
*
Expand Down Expand Up @@ -1221,7 +1221,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dapm_get_enum_double);
/**
* snd_soc_dapm_put_enum_double - dapm enumerated double mixer set callback
* @kcontrol: mixer control
* @uinfo: control element information
* @ucontrol: control element information
*
* Callback to set the value of a dapm enumerated double mixer control.
*
Expand Down Expand Up @@ -1419,7 +1419,7 @@ int snd_soc_dapm_set_bias_level(struct snd_soc_device *socdev,

/**
* snd_soc_dapm_enable_pin - enable pin.
* @snd_soc_codec: SoC codec
* @codec: SoC codec
* @pin: pin name
*
* Enables input/output pin and it's parents or children widgets iff there is
Expand Down

0 comments on commit ac11a2b

Please sign in to comment.