Commit b0649455 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

media: fix kernel-doc markups

Some identifiers have different names between their prototypes
and the kernel-doc markup. Seome seems to be due to cut-and-paste
related issues.

Others need to be fixed, as kernel-doc markups should use this format:
        identifier - description

Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com> # IPU3 and V4L2
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent 0d72f489
...@@ -33,7 +33,7 @@ struct ascot2e_config { ...@@ -33,7 +33,7 @@ struct ascot2e_config {
#if IS_REACHABLE(CONFIG_DVB_ASCOT2E) #if IS_REACHABLE(CONFIG_DVB_ASCOT2E)
/** /**
* Attach an ascot2e tuner * ascot2e_attach - Attach an ascot2e tuner
* *
* @fe: frontend to be attached * @fe: frontend to be attached
* @config: pointer to &struct ascot2e_config with tuner configuration. * @config: pointer to &struct ascot2e_config with tuner configuration.
......
...@@ -96,7 +96,7 @@ struct cxd2820r_config { ...@@ -96,7 +96,7 @@ struct cxd2820r_config {
#if IS_REACHABLE(CONFIG_DVB_CXD2820R) #if IS_REACHABLE(CONFIG_DVB_CXD2820R)
/** /**
* Attach a cxd2820r demod * cxd2820r_attach - Attach a cxd2820r demod
* *
* @config: pointer to &struct cxd2820r_config with demod configuration. * @config: pointer to &struct cxd2820r_config with demod configuration.
* @i2c: i2c adapter to use. * @i2c: i2c adapter to use.
......
...@@ -54,7 +54,7 @@ struct drxk_config { ...@@ -54,7 +54,7 @@ struct drxk_config {
#if IS_REACHABLE(CONFIG_DVB_DRXK) #if IS_REACHABLE(CONFIG_DVB_DRXK)
/** /**
* Attach a drxk demod * drxk_attach - Attach a drxk demod
* *
* @config: pointer to &struct drxk_config with demod configuration. * @config: pointer to &struct drxk_config with demod configuration.
* @i2c: i2c adapter to use. * @i2c: i2c adapter to use.
......
...@@ -38,7 +38,7 @@ struct dvb_pll_config { ...@@ -38,7 +38,7 @@ struct dvb_pll_config {
#if IS_REACHABLE(CONFIG_DVB_PLL) #if IS_REACHABLE(CONFIG_DVB_PLL)
/** /**
* Attach a dvb-pll to the supplied frontend structure. * dvb_pll_attach - Attach a dvb-pll to the supplied frontend structure.
* *
* @fe: Frontend to attach to. * @fe: Frontend to attach to.
* @pll_addr: i2c address of the PLL (if used). * @pll_addr: i2c address of the PLL (if used).
......
...@@ -44,7 +44,7 @@ struct helene_config { ...@@ -44,7 +44,7 @@ struct helene_config {
#if IS_REACHABLE(CONFIG_DVB_HELENE) #if IS_REACHABLE(CONFIG_DVB_HELENE)
/** /**
* Attach a helene tuner (terrestrial and cable standards) * helene_attach - Attach a helene tuner (terrestrial and cable standards)
* *
* @fe: frontend to be attached * @fe: frontend to be attached
* @config: pointer to &struct helene_config with tuner configuration. * @config: pointer to &struct helene_config with tuner configuration.
...@@ -57,7 +57,7 @@ extern struct dvb_frontend *helene_attach(struct dvb_frontend *fe, ...@@ -57,7 +57,7 @@ extern struct dvb_frontend *helene_attach(struct dvb_frontend *fe,
struct i2c_adapter *i2c); struct i2c_adapter *i2c);
/** /**
* Attach a helene tuner (satellite standards) * helene_attach_s - Attach a helene tuner (satellite standards)
* *
* @fe: frontend to be attached * @fe: frontend to be attached
* @config: pointer to &struct helene_config with tuner configuration. * @config: pointer to &struct helene_config with tuner configuration.
......
...@@ -33,7 +33,7 @@ struct horus3a_config { ...@@ -33,7 +33,7 @@ struct horus3a_config {
#if IS_REACHABLE(CONFIG_DVB_HORUS3A) #if IS_REACHABLE(CONFIG_DVB_HORUS3A)
/** /**
* Attach a horus3a tuner * horus3a_attach - Attach a horus3a tuner
* *
* @fe: frontend to be attached * @fe: frontend to be attached
* @config: pointer to &struct helene_config with tuner configuration. * @config: pointer to &struct helene_config with tuner configuration.
......
/* SPDX-License-Identifier: GPL-2.0-only */ /* SPDX-License-Identifier: GPL-2.0-only */
/** /*
* Driver for Sharp IX2505V (marked B0017) DVB-S silicon tuner * Driver for Sharp IX2505V (marked B0017) DVB-S silicon tuner
* *
* Copyright (C) 2010 Malcolm Priestley * Copyright (C) 2010 Malcolm Priestley
...@@ -31,7 +31,7 @@ struct ix2505v_config { ...@@ -31,7 +31,7 @@ struct ix2505v_config {
#if IS_REACHABLE(CONFIG_DVB_IX2505V) #if IS_REACHABLE(CONFIG_DVB_IX2505V)
/** /**
* Attach a ix2505v tuner to the supplied frontend structure. * ix2505v_attach - Attach a ix2505v tuner to the supplied frontend structure.
* *
* @fe: Frontend to attach to. * @fe: Frontend to attach to.
* @config: pointer to &struct ix2505v_config * @config: pointer to &struct ix2505v_config
......
...@@ -128,7 +128,7 @@ struct m88ds3103_config { ...@@ -128,7 +128,7 @@ struct m88ds3103_config {
#if defined(CONFIG_DVB_M88DS3103) || \ #if defined(CONFIG_DVB_M88DS3103) || \
(defined(CONFIG_DVB_M88DS3103_MODULE) && defined(MODULE)) (defined(CONFIG_DVB_M88DS3103_MODULE) && defined(MODULE))
/** /**
* Attach a m88ds3103 demod * m88ds3103_attach - Attach a m88ds3103 demod
* *
* @config: pointer to &struct m88ds3103_config with demod configuration. * @config: pointer to &struct m88ds3103_config with demod configuration.
* @i2c: i2c adapter to use. * @i2c: i2c adapter to use.
......
...@@ -26,7 +26,7 @@ struct mb86a20s_config { ...@@ -26,7 +26,7 @@ struct mb86a20s_config {
#if IS_REACHABLE(CONFIG_DVB_MB86A20S) #if IS_REACHABLE(CONFIG_DVB_MB86A20S)
/** /**
* Attach a mb86a20s demod * mb86a20s_attach - Attach a mb86a20s demod
* *
* @config: pointer to &struct mb86a20s_config with demod configuration. * @config: pointer to &struct mb86a20s_config with demod configuration.
* @i2c: i2c adapter to use. * @i2c: i2c adapter to use.
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
#if IS_REACHABLE(CONFIG_DVB_STB6000) #if IS_REACHABLE(CONFIG_DVB_STB6000)
/** /**
* Attach a stb6000 tuner to the supplied frontend structure. * stb6000_attach - Attach a stb6000 tuner to the supplied frontend structure.
* *
* @fe: Frontend to attach to. * @fe: Frontend to attach to.
* @addr: i2c address of the tuner. * @addr: i2c address of the tuner.
......
...@@ -14,7 +14,7 @@ ...@@ -14,7 +14,7 @@
#include <media/dvb_frontend.h> #include <media/dvb_frontend.h>
/** /**
* Attach a tda826x tuner to the supplied frontend structure. * tda826x_attach - Attach a tda826x tuner to the supplied frontend structure.
* *
* @fe: Frontend to attach to. * @fe: Frontend to attach to.
* @addr: i2c address of the tuner. * @addr: i2c address of the tuner.
......
/* SPDX-License-Identifier: GPL-2.0-only */ /* SPDX-License-Identifier: GPL-2.0-only */
/** /*
* Driver for Zarlink ZL10036 DVB-S silicon tuner * Driver for Zarlink ZL10036 DVB-S silicon tuner
* *
* Copyright (C) 2006 Tino Reichardt * Copyright (C) 2006 Tino Reichardt
...@@ -19,7 +19,7 @@ struct zl10036_config { ...@@ -19,7 +19,7 @@ struct zl10036_config {
#if IS_REACHABLE(CONFIG_DVB_ZL10036) #if IS_REACHABLE(CONFIG_DVB_ZL10036)
/** /**
* Attach a zl10036 tuner to the supplied frontend structure. * zl10036_attach - Attach a zl10036 tuner to the supplied frontend structure.
* *
* @fe: Frontend to attach to. * @fe: Frontend to attach to.
* @config: zl10036_config structure. * @config: zl10036_config structure.
......
...@@ -418,7 +418,7 @@ struct ipu3_uapi_af_config_s { ...@@ -418,7 +418,7 @@ struct ipu3_uapi_af_config_s {
IPU3_UAPI_AWB_FR_SPARE_FOR_BUBBLES) * IPU3_UAPI_MAX_STRIPES) IPU3_UAPI_AWB_FR_SPARE_FOR_BUBBLES) * IPU3_UAPI_MAX_STRIPES)
/** /**
* struct ipu3_uapi_awb_fr_meta_data - AWB filter response meta data * struct ipu3_uapi_awb_fr_raw_buffer - AWB filter response meta data
* *
* @meta_data: Statistics output on the grid after convolving with 1D filter. * @meta_data: Statistics output on the grid after convolving with 1D filter.
*/ */
...@@ -1506,7 +1506,7 @@ struct ipu3_uapi_sharp_cfg { ...@@ -1506,7 +1506,7 @@ struct ipu3_uapi_sharp_cfg {
} __packed; } __packed;
/** /**
* struct struct ipu3_uapi_far_w - Sharpening config for far sub-group * struct ipu3_uapi_far_w - Sharpening config for far sub-group
* *
* @dir_shrp: Weight of wide direct sharpening, u1.6, range [0, 64], default 64. * @dir_shrp: Weight of wide direct sharpening, u1.6, range [0, 64], default 64.
* @reserved0: reserved * @reserved0: reserved
...@@ -1526,7 +1526,7 @@ struct ipu3_uapi_far_w { ...@@ -1526,7 +1526,7 @@ struct ipu3_uapi_far_w {
} __packed; } __packed;
/** /**
* struct struct ipu3_uapi_unsharp_cfg - Unsharp config * struct ipu3_uapi_unsharp_cfg - Unsharp config
* *
* @unsharp_weight: Unsharp mask blending weight. * @unsharp_weight: Unsharp mask blending weight.
* u1.6, range [0, 64], default 16. * u1.6, range [0, 64], default 16.
...@@ -1772,7 +1772,7 @@ struct ipu3_uapi_vss_lut_y { ...@@ -1772,7 +1772,7 @@ struct ipu3_uapi_vss_lut_y {
} __packed; } __packed;
/** /**
* struct ipu3_uapi_yuvp1_iefd_vssnlm_cf - IEFd Vssnlm Lookup table * struct ipu3_uapi_yuvp1_iefd_vssnlm_cfg - IEFd Vssnlm Lookup table
* *
* @vss_lut_x: vss lookup table. See &ipu3_uapi_vss_lut_x description * @vss_lut_x: vss lookup table. See &ipu3_uapi_vss_lut_x description
* @vss_lut_y: vss lookup table. See &ipu3_uapi_vss_lut_y description * @vss_lut_y: vss lookup table. See &ipu3_uapi_vss_lut_y description
......
...@@ -321,7 +321,7 @@ int dvb_create_media_graph(struct dvb_adapter *adap, ...@@ -321,7 +321,7 @@ int dvb_create_media_graph(struct dvb_adapter *adap,
int dvb_generic_open(struct inode *inode, struct file *file); int dvb_generic_open(struct inode *inode, struct file *file);
/** /**
* dvb_generic_close - Digital TV close function, used by DVB devices * dvb_generic_release - Digital TV close function, used by DVB devices
* *
* @inode: pointer to &struct inode. * @inode: pointer to &struct inode.
* @file: pointer to &struct file. * @file: pointer to &struct file.
......
...@@ -1292,7 +1292,7 @@ static inline void v4l2_ctrl_request_hdl_put(struct v4l2_ctrl_handler *hdl) ...@@ -1292,7 +1292,7 @@ static inline void v4l2_ctrl_request_hdl_put(struct v4l2_ctrl_handler *hdl)
} }
/** /**
* v4l2_ctrl_request_ctrl_find() - Find a control with the given ID. * v4l2_ctrl_request_hdl_ctrl_find() - Find a control with the given ID.
* *
* @hdl: The control handler from the request. * @hdl: The control handler from the request.
* @id: The ID of the control to find. * @id: The ID of the control to find.
......
...@@ -43,8 +43,8 @@ enum vfl_devnode_type { ...@@ -43,8 +43,8 @@ enum vfl_devnode_type {
}; };
/** /**
* enum vfl_direction - Identifies if a &struct video_device corresponds * enum vfl_devnode_direction - Identifies if a &struct video_device
* to a receiver, a transmitter or a mem-to-mem device. * corresponds to a receiver, a transmitter or a mem-to-mem device.
* *
* @VFL_DIR_RX: device is a receiver. * @VFL_DIR_RX: device is a receiver.
* @VFL_DIR_TX: device is a transmitter. * @VFL_DIR_TX: device is a transmitter.
......
...@@ -174,7 +174,7 @@ int __must_check v4l2_device_register_subdev(struct v4l2_device *v4l2_dev, ...@@ -174,7 +174,7 @@ int __must_check v4l2_device_register_subdev(struct v4l2_device *v4l2_dev,
void v4l2_device_unregister_subdev(struct v4l2_subdev *sd); void v4l2_device_unregister_subdev(struct v4l2_subdev *sd);
/** /**
* __v4l2_device_register_ro_subdev_nodes - Registers device nodes for * __v4l2_device_register_subdev_nodes - Registers device nodes for
* all subdevs of the v4l2 device that are marked with the * all subdevs of the v4l2 device that are marked with the
* %V4L2_SUBDEV_FL_HAS_DEVNODE flag. * %V4L2_SUBDEV_FL_HAS_DEVNODE flag.
* *
......
...@@ -224,7 +224,7 @@ static inline bool can_reduce_fps(struct v4l2_bt_timings *bt) ...@@ -224,7 +224,7 @@ static inline bool can_reduce_fps(struct v4l2_bt_timings *bt)
} }
/** /**
* struct v4l2_hdmi_rx_colorimetry - describes the HDMI colorimetry information * struct v4l2_hdmi_colorimetry - describes the HDMI colorimetry information
* @colorspace: enum v4l2_colorspace, the colorspace * @colorspace: enum v4l2_colorspace, the colorspace
* @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
* @quantization: enum v4l2_quantization, colorspace quantization * @quantization: enum v4l2_quantization, colorspace quantization
......
...@@ -538,7 +538,7 @@ v4l2_async_notifier_parse_fwnode_endpoints_by_port(struct device *dev, ...@@ -538,7 +538,7 @@ v4l2_async_notifier_parse_fwnode_endpoints_by_port(struct device *dev,
parse_endpoint_func parse_endpoint); parse_endpoint_func parse_endpoint);
/** /**
* v4l2_fwnode_reference_parse_sensor_common - parse common references on * v4l2_async_notifier_parse_fwnode_sensor_common - parse common references on
* sensors for async sub-devices * sensors for async sub-devices
* @dev: the device node the properties of which are parsed for references * @dev: the device node the properties of which are parsed for references
* @notifier: the async notifier where the async subdevs will be added * @notifier: the async notifier where the async subdevs will be added
......
...@@ -147,7 +147,7 @@ v4l2_fill_pix_format(struct v4l2_pix_format *pix_fmt, ...@@ -147,7 +147,7 @@ v4l2_fill_pix_format(struct v4l2_pix_format *pix_fmt,
} }
/** /**
* v4l2_fill_pix_format - Ancillary routine that fills a &struct * v4l2_fill_mbus_format - Ancillary routine that fills a &struct
* v4l2_mbus_framefmt from a &struct v4l2_pix_format and a * v4l2_mbus_framefmt from a &struct v4l2_pix_format and a
* data format code. * data format code.
* *
...@@ -170,7 +170,7 @@ static inline void v4l2_fill_mbus_format(struct v4l2_mbus_framefmt *mbus_fmt, ...@@ -170,7 +170,7 @@ static inline void v4l2_fill_mbus_format(struct v4l2_mbus_framefmt *mbus_fmt,
} }
/** /**
* v4l2_fill_pix_format - Ancillary routine that fills a &struct * v4l2_fill_pix_format_mplane - Ancillary routine that fills a &struct
* v4l2_pix_format_mplane fields from a media bus structure. * v4l2_pix_format_mplane fields from a media bus structure.
* *
* @pix_mp_fmt: pointer to &struct v4l2_pix_format_mplane to be filled * @pix_mp_fmt: pointer to &struct v4l2_pix_format_mplane to be filled
...@@ -190,7 +190,7 @@ v4l2_fill_pix_format_mplane(struct v4l2_pix_format_mplane *pix_mp_fmt, ...@@ -190,7 +190,7 @@ v4l2_fill_pix_format_mplane(struct v4l2_pix_format_mplane *pix_mp_fmt,
} }
/** /**
* v4l2_fill_pix_format - Ancillary routine that fills a &struct * v4l2_fill_mbus_format_mplane - Ancillary routine that fills a &struct
* v4l2_mbus_framefmt from a &struct v4l2_pix_format_mplane. * v4l2_mbus_framefmt from a &struct v4l2_pix_format_mplane.
* *
* @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be filled * @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be filled
......
...@@ -309,7 +309,7 @@ struct v4l2_subdev_audio_ops { ...@@ -309,7 +309,7 @@ struct v4l2_subdev_audio_ops {
}; };
/** /**
* enum v4l2_mbus_frame_desc_entry - media bus frame description flags * enum v4l2_mbus_frame_desc_flags - media bus frame description flags
* *
* @V4L2_MBUS_FRAME_DESC_FL_LEN_MAX: * @V4L2_MBUS_FRAME_DESC_FL_LEN_MAX:
* Indicates that &struct v4l2_mbus_frame_desc_entry->length field * Indicates that &struct v4l2_mbus_frame_desc_entry->length field
......
...@@ -1043,7 +1043,7 @@ __poll_t vb2_core_poll(struct vb2_queue *q, struct file *file, ...@@ -1043,7 +1043,7 @@ __poll_t vb2_core_poll(struct vb2_queue *q, struct file *file,
size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count, size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
loff_t *ppos, int nonblock); loff_t *ppos, int nonblock);
/** /**
* vb2_read() - implements write() syscall logic. * vb2_write() - implements write() syscall logic.
* @q: pointer to &struct vb2_queue with videobuf2 queue. * @q: pointer to &struct vb2_queue with videobuf2 queue.
* @data: pointed to target userspace buffer * @data: pointed to target userspace buffer
* @count: number of bytes to write * @count: number of bytes to write
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment