media: vimc: fix kernel-doc markups

There are several markups there that doesn't follow the
specs. Fields should be like:

	@foo:

with a collon at the end. Also, continuation lines should
be aligned.

Failing to do that would cause kernel-doc to parse it wrong.
Some of the troubles will even cause warnings:

	$ ./scripts/kernel-doc -none drivers/media/test_drivers/vimc/vimc-common.h
	drivers/media/test_drivers/vimc/vimc-common.h:59: error: Cannot parse struct or union!
	drivers/media/test_drivers/vimc/vimc-common.h:77: warning: Function parameter or member 'bpp' not described in 'vimc_pix_map'
	drivers/media/test_drivers/vimc/vimc-common.h:120: warning: Function parameter or member 'pipe_cfg' not described in 'vimc_device'
	drivers/media/test_drivers/vimc/vimc-common.h:120: warning: Function parameter or member 'ent_devs' not described in 'vimc_device'
	drivers/media/test_drivers/vimc/vimc-common.h:120: warning: Function parameter or member 'mdev' not described in 'vimc_device'
	drivers/media/test_drivers/vimc/vimc-common.h:120: warning: Function parameter or member 'v4l2_dev' not described in 'vimc_device'
	drivers/media/test_drivers/vimc/vimc-common.h:137: warning: Function parameter or member 'add' not described in 'vimc_ent_type'
	drivers/media/test_drivers/vimc/vimc-common.h:137: warning: Function parameter or member 'unregister' not described in 'vimc_ent_type'
	drivers/media/test_drivers/vimc/vimc-common.h:137: warning: Function parameter or member 'release' not described in 'vimc_ent_type'
	drivers/media/test_drivers/vimc/vimc-common.h:150: warning: Function parameter or member 'name' not described in 'vimc_ent_config'
	drivers/media/test_drivers/vimc/vimc-common.h:150: warning: Function parameter or member 'type' not described in 'vimc_ent_config'
	drivers/media/test_drivers/vimc/vimc-common.h:197: warning: bad line:                 flags of the pads

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

diff --git a/drivers/media/test_drivers/vimc/vimc-common.h b/drivers/media/test_drivers/vimc/vimc-common.h
index 1155eba..487bd02 100644 (file)
--- a/drivers/media/test_drivers/vimc/vimc-common.h
+++ b/drivers/media/test_drivers/vimc/vimc-common.h
@@ -33,7 +33,7 @@
 #define VIMC_IS_SINK(pad)      (!(pad))
 
 /**
- * struct vimc_colorimetry_clamp - Adjust colorimetry parameters
+ * vimc_colorimetry_clamp - Adjust colorimetry parameters
  *
  * @fmt:               the pointer to struct v4l2_pix_format or
  *                     struct v4l2_mbus_framefmt
@@ -62,7 +62,7 @@ do {                                                                  \
  * struct vimc_pix_map - maps media bus code with v4l2 pixel format
  *
  * @code:              media bus format code defined by MEDIA_BUS_FMT_* macros
- * @bbp:               number of bytes each pixel occupies
+ * @bpp:               number of bytes each pixel occupies
  * @pixelformat:       pixel format defined by V4L2_PIX_FMT_* macros
  * @bayer:             true if this is a bayer format
  *
@@ -107,10 +107,10 @@ struct vimc_ent_device {
 /**
  * struct vimc_device - main device for vimc driver
  *
- * @pipe_cfg   pointer to the vimc pipeline configuration structure
- * @ent_devs   array of vimc_ent_device pointers
- * @mdev       the associated media_device parent
- * @v4l2_dev   Internal v4l2 parent device
+ * @pipe_cfg:  pointer to the vimc pipeline configuration structure
+ * @ent_devs:  array of vimc_ent_device pointers
+ * @mdev:      the associated media_device parent
+ * @v4l2_dev:  Internal v4l2 parent device
  */
 struct vimc_device {
        const struct vimc_pipeline_config *pipe_cfg;
@@ -123,11 +123,11 @@ struct vimc_device {
  * struct vimc_ent_type                Structure for the callbacks of the entity types
  *
  *
- * @add                                initializes and registers
- *                                     vimc entity - called from vimc-core
- * @unregister                 unregisters vimc entity - called from vimc-core
- * @release                    releases vimc entity - called from the v4l2_dev
- *                                     release callback
+ * @add:                       initializes and registers
+ *                             vimc entity - called from vimc-core
+ * @unregister:                        unregisters vimc entity - called from vimc-core
+ * @release:                   releases vimc entity - called from the v4l2_dev
+ *                             release callback
  */
 struct vimc_ent_type {
        struct vimc_ent_device *(*add)(struct vimc_device *vimc,
@@ -140,8 +140,8 @@ struct vimc_ent_type {
  * struct vimc_ent_config      Structure which describes individual
  *                             configuration for each entity
  *
- * @name                       entity name
- * @type                       contain the callbacks of this entity type
+ * @name:                      entity name
+ * @type:                      contain the callbacks of this entity type
  *
  */
 struct vimc_ent_config {
@@ -194,7 +194,7 @@ const struct vimc_pix_map *vimc_pix_map_by_pixelformat(u32 pixelformat);
  * @function:  media entity function defined by MEDIA_ENT_F_* macros
  * @num_pads:  number of pads to initialize
  * @pads:      the array of pads of the entity, the caller should set the
-               flags of the pads
+ *             flags of the pads
  * @sd_ops:    pointer to &struct v4l2_subdev_ops.
  *
  * Helper function initialize and register the struct vimc_ent_device and struct

diff --git a/drivers/media/test_drivers/vimc/vimc-streamer.h b/drivers/media/test_drivers/vimc/vimc-streamer.h
index fe3c51f..3bb6731 100644 (file)
--- a/drivers/media/test_drivers/vimc/vimc-streamer.h
+++ b/drivers/media/test_drivers/vimc/vimc-streamer.h
@@ -20,9 +20,10 @@
  *
  * @pipe:              the media pipeline object associated with this stream
  * @ved_pipeline:      array containing all the entities participating in the
- * stream. The order is from a video device (usually a capture device) where
- * stream_on was called, to the entity generating the first base image to be
- * processed in the pipeline.
+ *                     stream. The order is from a video device (usually a
+ *                     capture device) where stream_on was called, to the
+ *                     entity generating the first base image to be
+ *                     processed in the pipeline.
  * @pipe_size:         size of @ved_pipeline
  * @kthread:           thread that generates the frames of the stream.
  *