tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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: Takashi Iwai <tiwai@suse.de>
+9
-8
+9
-8
include/uapi/sound/compress_offload.h
+9
-8
include/uapi/sound/compress_offload.h
···
32
32
33
33
#define SNDRV_COMPRESS_VERSION SNDRV_PROTOCOL_VERSION(0, 1, 2)
34
34
/**
35
-
* struct snd_compressed_buffer: compressed buffer
35
+
* struct snd_compressed_buffer - compressed buffer
36
36
* @fragment_size: size of buffer fragment in bytes
37
37
* @fragments: number of such fragments
38
38
*/
···
42
42
} __attribute__((packed, aligned(4)));
43
43
44
44
/**
45
-
* struct snd_compr_params: compressed stream params
45
+
* struct snd_compr_params - compressed stream params
46
46
* @buffer: buffer description
47
47
* @codec: codec parameters
48
48
* @no_wake_mode: dont wake on fragment elapsed
···
54
54
} __attribute__((packed, aligned(4)));
55
55
56
56
/**
57
-
* struct snd_compr_tstamp: timestamp descriptor
57
+
* struct snd_compr_tstamp - timestamp descriptor
58
58
* @byte_offset: Byte offset in ring buffer to DSP
59
59
* @copied_total: Total number of bytes copied from/to ring buffer to/by DSP
60
60
* @pcm_frames: Frames decoded or encoded by DSP. This field will evolve by
···
73
73
} __attribute__((packed, aligned(4)));
74
74
75
75
/**
76
-
* struct snd_compr_avail: avail descriptor
76
+
* struct snd_compr_avail - avail descriptor
77
77
* @avail: Number of bytes available in ring buffer for writing/reading
78
78
* @tstamp: timestamp infomation
79
79
*/
···
88
88
};
89
89
90
90
/**
91
-
* struct snd_compr_caps: caps descriptor
91
+
* struct snd_compr_caps - caps descriptor
92
92
* @codecs: pointer to array of codecs
93
93
* @direction: direction supported. Of type snd_compr_direction
94
94
* @min_fragment_size: minimum fragment supported by DSP
···
110
110
} __attribute__((packed, aligned(4)));
111
111
112
112
/**
113
-
* struct snd_compr_codec_caps: query capability of codec
113
+
* struct snd_compr_codec_caps - query capability of codec
114
114
* @codec: codec for which capability is queried
115
115
* @num_descriptors: number of codec descriptors
116
116
* @descriptor: array of codec capability descriptor
···
122
122
} __attribute__((packed, aligned(4)));
123
123
124
124
/**
125
+
* enum sndrv_compress_encoder
125
126
* @SNDRV_COMPRESS_ENCODER_PADDING: no of samples appended by the encoder at the
126
127
* end of the track
127
128
* @SNDRV_COMPRESS_ENCODER_DELAY: no of samples inserted by the encoder at the
128
129
* beginning of the track
129
130
*/
130
-
enum {
131
+
enum sndrv_compress_encoder {
131
132
SNDRV_COMPRESS_ENCODER_PADDING = 1,
132
133
SNDRV_COMPRESS_ENCODER_DELAY = 2,
133
134
};
134
135
135
136
/**
136
-
* struct snd_compr_metadata: compressed stream metadata
137
+
* struct snd_compr_metadata - compressed stream metadata
137
138
* @key: key id
138
139
* @value: key value
139
140
*/