[alsa-devel] [PATCH] ALSA: firewire-lib: add missing description for kerneldoc
A description for second paramter for cmp_connection_check_used() is missing.
Signed-off-by: Takashi Sakamoto o-takashi@sakamocchi.jp --- sound/firewire/cmp.c | 1 + 1 file changed, 1 insertion(+)
diff --git a/sound/firewire/cmp.c b/sound/firewire/cmp.c index ba8df5a..dcccb01 100644 --- a/sound/firewire/cmp.c +++ b/sound/firewire/cmp.c @@ -154,6 +154,7 @@ EXPORT_SYMBOL(cmp_connection_init); /** * cmp_connection_check_used - check connection is already esablished or not * @c: the connection manager to be checked + * @used: the pointer to store result to check the connection */ int cmp_connection_check_used(struct cmp_connection *c, bool *used) {
At Wed, 12 Nov 2014 22:55:27 +0900, Takashi Sakamoto wrote:
A description for second paramter for cmp_connection_check_used() is missing.
Well, I see a few more errors:
Warning(cmp.c:124): No description found for parameter 'direction' Warning(cmp.c:160): No description found for parameter 'used' Warning(amdtp.h:44): Enum value 'CIP_SKIP_DBC_ZERO_CHECK' not described in enum 'cip_flags' Warning(amdtp.h:58): Enum value 'CIP_SFC_32000' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_44100' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_48000' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_88200' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_96000' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_176400' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_192000' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_COUNT' not described in enum 'cip_sfc'
Could you fix these as well? (amdtp.h enum errors look stupid, though...)
Takashi
Signed-off-by: Takashi Sakamoto o-takashi@sakamocchi.jp
sound/firewire/cmp.c | 1 + 1 file changed, 1 insertion(+)
diff --git a/sound/firewire/cmp.c b/sound/firewire/cmp.c index ba8df5a..dcccb01 100644 --- a/sound/firewire/cmp.c +++ b/sound/firewire/cmp.c @@ -154,6 +154,7 @@ EXPORT_SYMBOL(cmp_connection_init); /**
- cmp_connection_check_used - check connection is already esablished or not
- @c: the connection manager to be checked
*/
- @used: the pointer to store result to check the connection
int cmp_connection_check_used(struct cmp_connection *c, bool *used) { -- 2.1.0
HI,
On Nov 12 2014 22:59, Takashi Iwai wrote:
Could you fix these as well? (amdtp.h enum errors look stupid, though...)
OK.
Warning(amdtp.h:44): Enum value 'CIP_SKIP_DBC_ZERO_CHECK' not described in enum 'cip_flags'
This is due to my typo.
Warning(amdtp.h:58): Enum value 'CIP_SFC_32000' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_44100' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_48000' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_88200' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_96000' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_176400' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_192000' not described in enum 'cip_sfc' Warning(amdtp.h:58): Enum value 'CIP_SFC_COUNT' not described in enum 'cip_sfc'
A lack of descriptions. I think it good to refer to IEC 61883-1 in these description.
Regards
Takashi Sakamoto o-takashi@sakamocchi.jp
participants (2)
-
Takashi Iwai -
Takashi Sakamoto