diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2008-10-15 17:38:40 -0400 |
---|---|---|
committer | Takashi Iwai <tiwai@suse.de> | 2008-10-16 02:44:20 -0400 |
commit | 1c85cc64456c97f3b265788abafec5c482c6a908 (patch) | |
tree | 43821869f0dd0e144a30c5d1159f3adf53b8fbd2 /sound/core/pcm_native.c | |
parent | 9a3f371e9962749e5bdcf45a3bebdba555651a2b (diff) |
ALSA: kernel docs: fix sound/core/ kernel-doc
Add kernel-doc function short descriptions to sound/core functions that
are missing this short description. Mostly this involves moving some of
the function description onto the @funcname line.
Also correct a few variable names and fix other kernel-doc notation.
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'sound/core/pcm_native.c')
-rw-r--r-- | sound/core/pcm_native.c | 24 |
1 files changed, 8 insertions, 16 deletions
diff --git a/sound/core/pcm_native.c b/sound/core/pcm_native.c index e61e12506ded..aef18682c035 100644 --- a/sound/core/pcm_native.c +++ b/sound/core/pcm_native.c | |||
@@ -875,10 +875,8 @@ static struct action_ops snd_pcm_action_start = { | |||
875 | }; | 875 | }; |
876 | 876 | ||
877 | /** | 877 | /** |
878 | * snd_pcm_start | 878 | * snd_pcm_start - start all linked streams |
879 | * @substream: the PCM substream instance | 879 | * @substream: the PCM substream instance |
880 | * | ||
881 | * Start all linked streams. | ||
882 | */ | 880 | */ |
883 | int snd_pcm_start(struct snd_pcm_substream *substream) | 881 | int snd_pcm_start(struct snd_pcm_substream *substream) |
884 | { | 882 | { |
@@ -926,12 +924,11 @@ static struct action_ops snd_pcm_action_stop = { | |||
926 | }; | 924 | }; |
927 | 925 | ||
928 | /** | 926 | /** |
929 | * snd_pcm_stop | 927 | * snd_pcm_stop - try to stop all running streams in the substream group |
930 | * @substream: the PCM substream instance | 928 | * @substream: the PCM substream instance |
931 | * @state: PCM state after stopping the stream | 929 | * @state: PCM state after stopping the stream |
932 | * | 930 | * |
933 | * Try to stop all running streams in the substream group. | 931 | * The state of each stream is then changed to the given state unconditionally. |
934 | * The state of each stream is changed to the given value after that unconditionally. | ||
935 | */ | 932 | */ |
936 | int snd_pcm_stop(struct snd_pcm_substream *substream, int state) | 933 | int snd_pcm_stop(struct snd_pcm_substream *substream, int state) |
937 | { | 934 | { |
@@ -941,11 +938,10 @@ int snd_pcm_stop(struct snd_pcm_substream *substream, int state) | |||
941 | EXPORT_SYMBOL(snd_pcm_stop); | 938 | EXPORT_SYMBOL(snd_pcm_stop); |
942 | 939 | ||
943 | /** | 940 | /** |
944 | * snd_pcm_drain_done | 941 | * snd_pcm_drain_done - stop the DMA only when the given stream is playback |
945 | * @substream: the PCM substream | 942 | * @substream: the PCM substream |
946 | * | 943 | * |
947 | * Stop the DMA only when the given stream is playback. | 944 | * After stopping, the state is changed to SETUP. |
948 | * The state is changed to SETUP. | ||
949 | * Unlike snd_pcm_stop(), this affects only the given stream. | 945 | * Unlike snd_pcm_stop(), this affects only the given stream. |
950 | */ | 946 | */ |
951 | int snd_pcm_drain_done(struct snd_pcm_substream *substream) | 947 | int snd_pcm_drain_done(struct snd_pcm_substream *substream) |
@@ -1065,10 +1061,9 @@ static struct action_ops snd_pcm_action_suspend = { | |||
1065 | }; | 1061 | }; |
1066 | 1062 | ||
1067 | /** | 1063 | /** |
1068 | * snd_pcm_suspend | 1064 | * snd_pcm_suspend - trigger SUSPEND to all linked streams |
1069 | * @substream: the PCM substream | 1065 | * @substream: the PCM substream |
1070 | * | 1066 | * |
1071 | * Trigger SUSPEND to all linked streams. | ||
1072 | * After this call, all streams are changed to SUSPENDED state. | 1067 | * After this call, all streams are changed to SUSPENDED state. |
1073 | */ | 1068 | */ |
1074 | int snd_pcm_suspend(struct snd_pcm_substream *substream) | 1069 | int snd_pcm_suspend(struct snd_pcm_substream *substream) |
@@ -1088,10 +1083,9 @@ int snd_pcm_suspend(struct snd_pcm_substream *substream) | |||
1088 | EXPORT_SYMBOL(snd_pcm_suspend); | 1083 | EXPORT_SYMBOL(snd_pcm_suspend); |
1089 | 1084 | ||
1090 | /** | 1085 | /** |
1091 | * snd_pcm_suspend_all | 1086 | * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm |
1092 | * @pcm: the PCM instance | 1087 | * @pcm: the PCM instance |
1093 | * | 1088 | * |
1094 | * Trigger SUSPEND to all substreams in the given pcm. | ||
1095 | * After this call, all streams are changed to SUSPENDED state. | 1089 | * After this call, all streams are changed to SUSPENDED state. |
1096 | */ | 1090 | */ |
1097 | int snd_pcm_suspend_all(struct snd_pcm *pcm) | 1091 | int snd_pcm_suspend_all(struct snd_pcm *pcm) |
@@ -1313,11 +1307,9 @@ static struct action_ops snd_pcm_action_prepare = { | |||
1313 | }; | 1307 | }; |
1314 | 1308 | ||
1315 | /** | 1309 | /** |
1316 | * snd_pcm_prepare | 1310 | * snd_pcm_prepare - prepare the PCM substream to be triggerable |
1317 | * @substream: the PCM substream instance | 1311 | * @substream: the PCM substream instance |
1318 | * @file: file to refer f_flags | 1312 | * @file: file to refer f_flags |
1319 | * | ||
1320 | * Prepare the PCM substream to be triggerable. | ||
1321 | */ | 1313 | */ |
1322 | static int snd_pcm_prepare(struct snd_pcm_substream *substream, | 1314 | static int snd_pcm_prepare(struct snd_pcm_substream *substream, |
1323 | struct file *file) | 1315 | struct file *file) |