Commit 539311aa authored by Takashi Iwai's avatar Takashi Iwai
Browse files

ALSA: compress: Enable kernel doc markers for some functions 



The exported functions snd_compress_new() and snd_compr_stop_error()
had already kernel-doc-style comments but they were not processed as
they weren't marked properly.  Let's enable them.

This patch also fixes the missing argument id for snd_compress_new
comments, too.

Reported-by: default avatarMauro Carvalho Chehab <mchehab@kernel.org>
Link: https://lore.kernel.org/r/3cd6b93b36b32ad6ae160931aaa00b20688e241a.1656759989.git.mchehab@kernel.org
Link: https://lore.kernel.org/r/20220713104759.4365-2-tiwai@suse.de


Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 33c1f401

sound/core/compress_offload.c

+3 −2
Original line number Diff line number Diff line
@@ -810,7 +810,7 @@ static void error_delayed_work(struct work_struct *work) 
	mutex_unlock(&stream->device->lock);

}



/*

/**

 * snd_compr_stop_error: Report a fatal error on a stream

 * @stream: pointer to stream

 * @state: state to transition the stream to
@@ -1157,11 +1157,12 @@ static int snd_compress_dev_free(struct snd_device *device) 
	return 0;

}



/*

/**

 * snd_compress_new: create new compress device

 * @card: sound card pointer

 * @device: device number

 * @dirn: device direction, should be of type enum snd_compr_direction

 * @id: ID string

 * @compr: compress device pointer

 */

int snd_compress_new(struct snd_card *card, int device,