Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[media] Docbook: Fix comments at v4l2-mem2mem.h

Warning(.//include/media/v4l2-mem2mem.h:50): No description found for parameter 'lock'
Warning(.//include/media/v4l2-mem2mem.h:50): No description found for parameter 'unlock'
Warning(.//include/media/v4l2-mem2mem.h:167): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:177): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:188): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:197): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:206): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:215): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:226): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:235): No description found for parameter 'm2m_ctx'

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>

+20
+20
include/media/v4l2-mem2mem.h
··· 40 40 * v4l2_m2m_job_finish() (as if the transaction ended normally). 41 41 * This function does not have to (and will usually not) wait 42 42 * until the device enters a state when it can be stopped. 43 + * @lock: optional. Define a driver's own lock callback, instead of using 44 + * m2m_ctx->q_lock. 45 + * @unlock: optional. Define a driver's own unlock callback, instead of 46 + * using m2m_ctx->q_lock. 43 47 */ 44 48 struct v4l2_m2m_ops { 45 49 void (*device_run)(void *priv); ··· 165 161 /** 166 162 * v4l2_m2m_num_src_bufs_ready() - return the number of source buffers ready for 167 163 * use 164 + * 165 + * @m2m_ctx: pointer to struct v4l2_m2m_ctx 168 166 */ 169 167 static inline 170 168 unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx) ··· 177 171 /** 178 172 * v4l2_m2m_num_src_bufs_ready() - return the number of destination buffers 179 173 * ready for use 174 + * 175 + * @m2m_ctx: pointer to struct v4l2_m2m_ctx 180 176 */ 181 177 static inline 182 178 unsigned int v4l2_m2m_num_dst_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx) ··· 191 183 /** 192 184 * v4l2_m2m_next_src_buf() - return next source buffer from the list of ready 193 185 * buffers 186 + * 187 + * @m2m_ctx: pointer to struct v4l2_m2m_ctx 194 188 */ 195 189 static inline void *v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *m2m_ctx) 196 190 { ··· 202 192 /** 203 193 * v4l2_m2m_next_dst_buf() - return next destination buffer from the list of 204 194 * ready buffers 195 + * 196 + * @m2m_ctx: pointer to struct v4l2_m2m_ctx 205 197 */ 206 198 static inline void *v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *m2m_ctx) 207 199 { ··· 212 200 213 201 /** 214 202 * v4l2_m2m_get_src_vq() - return vb2_queue for source buffers 203 + * 204 + * @m2m_ctx: pointer to struct v4l2_m2m_ctx 215 205 */ 216 206 static inline 217 207 struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx) ··· 223 209 224 210 /** 225 211 * v4l2_m2m_get_dst_vq() - return vb2_queue for destination buffers 212 + * 213 + * @m2m_ctx: pointer to struct v4l2_m2m_ctx 226 214 */ 227 215 static inline 228 216 struct vb2_queue *v4l2_m2m_get_dst_vq(struct v4l2_m2m_ctx *m2m_ctx) ··· 237 221 /** 238 222 * v4l2_m2m_src_buf_remove() - take off a source buffer from the list of ready 239 223 * buffers and return it 224 + * 225 + * @m2m_ctx: pointer to struct v4l2_m2m_ctx 240 226 */ 241 227 static inline void *v4l2_m2m_src_buf_remove(struct v4l2_m2m_ctx *m2m_ctx) 242 228 { ··· 248 230 /** 249 231 * v4l2_m2m_dst_buf_remove() - take off a destination buffer from the list of 250 232 * ready buffers and return it 233 + * 234 + * @m2m_ctx: pointer to struct v4l2_m2m_ctx 251 235 */ 252 236 static inline void *v4l2_m2m_dst_buf_remove(struct v4l2_m2m_ctx *m2m_ctx) 253 237 {