Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
ALSA: compress: Fix kernel doc warnings
Each kernel doc comment expects the definition of the return value and
the summary for each struct / enum in a proper format. This patch
adds or fixes the missing entries for compress-offload API.
Link: https://lore.kernel.org/r/20220713104759.4365-5-tiwai@suse.de
Signed-off-by: Takashi Iwai <tiwai@suse.de>
+8
-4
+1
-1
include/uapi/sound/compress_offload.h
+1
-1
include/uapi/sound/compress_offload.h
···
123
123
} __attribute__((packed, aligned(4)));
124
124
125
125
/**
126
-
* enum sndrv_compress_encoder
126
+
* enum sndrv_compress_encoder - encoder metadata key
127
127
* @SNDRV_COMPRESS_ENCODER_PADDING: no of samples appended by the encoder at the
128
128
* end of the track
129
129
* @SNDRV_COMPRESS_ENCODER_DELAY: no of samples inserted by the encoder at the
+3
-3
include/uapi/sound/compress_params.h
+3
-3
include/uapi/sound/compress_params.h
···
250
250
251
251
252
252
/**
253
-
* struct snd_enc_vorbis
253
+
* struct snd_enc_vorbis - Vorbis encoder parameters
254
254
* @quality: Sets encoding quality to n, between -1 (low) and 10 (high).
255
255
* In the default mode of operation, the quality level is 3.
256
256
* Normal quality range is 0 - 10.
···
279
279
280
280
281
281
/**
282
-
* struct snd_enc_real
282
+
* struct snd_enc_real - RealAudio encoder parameters
283
283
* @quant_bits: number of coupling quantization bits in the stream
284
284
* @start_region: coupling start region in the stream
285
285
* @num_regions: number of regions value
···
294
294
} __attribute__((packed, aligned(4)));
295
295
296
296
/**
297
-
* struct snd_enc_flac
297
+
* struct snd_enc_flac - FLAC encoder parameters
298
298
* @num: serial number, valid only for OGG formats
299
299
* needs to be set by application
300
300
* @gain: Add replay gain tags
+4
sound/core/compress_offload.c
+4
sound/core/compress_offload.c
···
818
818
* Stop the stream and set its state.
819
819
*
820
820
* Should be called with compressed device lock held.
821
+
*
822
+
* Return: zero if successful, or a negative error code
821
823
*/
822
824
int snd_compr_stop_error(struct snd_compr_stream *stream,
823
825
snd_pcm_state_t state)
···
1166
1164
* @dirn: device direction, should be of type enum snd_compr_direction
1167
1165
* @id: ID string
1168
1166
* @compr: compress device pointer
1167
+
*
1168
+
* Return: zero if successful, or a negative error code
1169
1169
*/
1170
1170
int snd_compress_new(struct snd_card *card, int device,
1171
1171
int dirn, const char *id, struct snd_compr *compr)