[PATCH] ASoC: fix documentation in soc-jack

[PATCH] ASoC: fix documentation in soc-jack

[Peter Meerwald]

From: Peter Meerwald <p.meerwald@bct-electronic.com>

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
---
 sound/soc/soc-jack.c |    7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/sound/soc/soc-jack.c b/sound/soc/soc-jack.c
index 0c17293..b24cd53 100644
--- a/sound/soc/soc-jack.c
+++ b/sound/soc/soc-jack.c
@@ -22,7 +22,7 @@
 
 /**
  * snd_soc_jack_new - Create a new jack
- * @card:  ASoC card
+ * @codec: ASoC codec
  * @id:    an identifying string for this jack
  * @type:  a bitmask of enum snd_jack_type values that can be detected by
  *         this jack
@@ -139,12 +139,13 @@ EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);
 
 /**
  * snd_soc_jack_get_type - Based on the mic bias value, this function returns
- * the type of jack from the zones delcared in the jack type
+ * the type of jack from the zones declared in the jack type
  *
+ * @jack:  ASoC jack
  * @micbias_voltage:  mic bias voltage at adc channel when jack is plugged in
  *
  * Based on the mic bias value passed, this function helps identify
- * the type of jack from the already delcared jack zones
+ * the type of jack from the already declared jack zones
  */
 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage)
 {
-- 
1.7.9.5

Re: [PATCH] ASoC: fix documentation in soc-jack

[Mark Brown]

On Tue, Oct 02, 2012 at 02:08:19PM +0200, Peter Meerwald wrote:
> From: Peter Meerwald <p.meerwald@bct-electronic.com>
> 
> Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

Applied, thanks.  It would be helpful if your changelogs were, uh,
better documented :) - it does make life much easier when reviewing if
you've got an idea as to what's in the patch when you start reading it.

Something like "fixes spelling mistakes and mislabelled parameters" for
example.