Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f533ccb6 authored by Takashi Iwai's avatar Takashi Iwai
Browse files

ALSA: doc: Fix uapi/sound/compress_offload.h kerneldoc comments 



so that make htmldocs works properly.
Since kerneldoc can't handle noname enum properly, name enum
sndrv_compress_encoder.

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

include/uapi/sound/compress_offload.h

+9 −8
Original line number Diff line number Diff line
@@ -32,7 +32,7 @@ 


#define SNDRV_COMPRESS_VERSION SNDRV_PROTOCOL_VERSION(0, 1, 2)

/**

 * struct snd_compressed_buffer: compressed buffer

 * struct snd_compressed_buffer - compressed buffer

 * @fragment_size: size of buffer fragment in bytes

 * @fragments: number of such fragments

 */
@@ -42,7 +42,7 @@ struct snd_compressed_buffer { 
} __attribute__((packed, aligned(4)));



/**

 * struct snd_compr_params: compressed stream params

 * struct snd_compr_params - compressed stream params

 * @buffer: buffer description

 * @codec: codec parameters

 * @no_wake_mode: dont wake on fragment elapsed
@@ -54,7 +54,7 @@ struct snd_compr_params { 
} __attribute__((packed, aligned(4)));



/**

 * struct snd_compr_tstamp: timestamp descriptor

 * struct snd_compr_tstamp - timestamp descriptor

 * @byte_offset: Byte offset in ring buffer to DSP

 * @copied_total: Total number of bytes copied from/to ring buffer to/by DSP

 * @pcm_frames: Frames decoded or encoded by DSP. This field will evolve by
@@ -73,7 +73,7 @@ struct snd_compr_tstamp { 
} __attribute__((packed, aligned(4)));



/**

 * struct snd_compr_avail: avail descriptor

 * struct snd_compr_avail - avail descriptor

 * @avail: Number of bytes available in ring buffer for writing/reading

 * @tstamp: timestamp infomation

 */
@@ -88,7 +88,7 @@ enum snd_compr_direction { 
};



/**

 * struct snd_compr_caps: caps descriptor

 * struct snd_compr_caps - caps descriptor

 * @codecs: pointer to array of codecs

 * @direction: direction supported. Of type snd_compr_direction

 * @min_fragment_size: minimum fragment supported by DSP
@@ -110,7 +110,7 @@ struct snd_compr_caps { 
} __attribute__((packed, aligned(4)));



/**

 * struct snd_compr_codec_caps: query capability of codec

 * struct snd_compr_codec_caps - query capability of codec

 * @codec: codec for which capability is queried

 * @num_descriptors: number of codec descriptors

 * @descriptor: array of codec capability descriptor
@@ -122,18 +122,19 @@ struct snd_compr_codec_caps { 
} __attribute__((packed, aligned(4)));



/**

 * enum sndrv_compress_encoder

 * @SNDRV_COMPRESS_ENCODER_PADDING: no of samples appended by the encoder at the

 * end of the track

 * @SNDRV_COMPRESS_ENCODER_DELAY: no of samples inserted by the encoder at the

 * beginning of the track

 */

enum {

enum sndrv_compress_encoder {

	SNDRV_COMPRESS_ENCODER_PADDING = 1,

	SNDRV_COMPRESS_ENCODER_DELAY = 2,

};



/**

 * struct snd_compr_metadata: compressed stream metadata

 * struct snd_compr_metadata - compressed stream metadata

 * @key: key id

 * @value: key value

 */