diff mbox series

allegro: change kernel-doc comment blocks to normal comments

Message ID 2d849748-bca7-83ef-0308-a8cc5901f127@xs4all.nl (mailing list archive)
State New
Headers show
Series allegro: change kernel-doc comment blocks to normal comments | expand

Commit Message

Hans Verkuil April 7, 2021, 7:36 a.m. UTC
The /** at the start indicates that these are kernel-doc comments, but really
these are just regular comments.

Replace /** by /* to avoid a large number of warnings from kernel-doc.

Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Suggested-by: Michael Tretter <m.tretter@pengutronix.de>
---

Comments

Michael Tretter April 9, 2021, 1:07 p.m. UTC | #1
On Wed, 07 Apr 2021 09:36:06 +0200, Hans Verkuil wrote:
> The /** at the start indicates that these are kernel-doc comments, but really
> these are just regular comments.
> 
> Replace /** by /* to avoid a large number of warnings from kernel-doc.

Sorry for being late... I made the mistake of adding it to my todo list
instead of just changing it.

> 
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
> Suggested-by: Michael Tretter <m.tretter@pengutronix.de>

Reviewed-by: Michael Tretter <m.tretter@pengutronix.de>

> ---
> diff --git a/drivers/media/platform/allegro-dvt/nal-h264.h b/drivers/media/platform/allegro-dvt/nal-h264.h
> index 8cc5a28bf237..a19634fe8c0b 100644
> --- a/drivers/media/platform/allegro-dvt/nal-h264.h
> +++ b/drivers/media/platform/allegro-dvt/nal-h264.h
> @@ -11,7 +11,7 @@
>  #include <linux/kernel.h>
>  #include <linux/types.h>
> 
> -/**
> +/*
>   * struct nal_h264_hrd_parameters - HRD parameters
>   *
>   * C struct representation of the sequence parameter set NAL unit as defined by
> @@ -32,7 +32,7 @@ struct nal_h264_hrd_parameters {
>  	unsigned int time_offset_length;
>  };
> 
> -/**
> +/*
>   * struct nal_h264_vui_parameters - VUI parameters
>   *
>   * C struct representation of the VUI parameters as defined by Rec. ITU-T
> @@ -87,7 +87,7 @@ struct nal_h264_vui_parameters {
>  	};
>  };
> 
> -/**
> +/*
>   * struct nal_h264_sps - Sequence parameter set
>   *
>   * C struct representation of the sequence parameter set NAL unit as defined by
> @@ -142,7 +142,7 @@ struct nal_h264_sps {
>  	struct nal_h264_vui_parameters vui;
>  };
> 
> -/**
> +/*
>   * struct nal_h264_pps - Picture parameter set
>   *
>   * C struct representation of the picture parameter set NAL unit as defined by
> diff --git a/drivers/media/platform/allegro-dvt/nal-hevc.h b/drivers/media/platform/allegro-dvt/nal-hevc.h
> index fc994d4242d8..c09bbe5446aa 100644
> --- a/drivers/media/platform/allegro-dvt/nal-hevc.h
> +++ b/drivers/media/platform/allegro-dvt/nal-hevc.h
> @@ -54,7 +54,7 @@ struct nal_hevc_profile_tier_level {
>  	unsigned int general_level_idc;
>  };
> 
> -/**
> +/*
>   * struct nal_hevc_vps - Video parameter set
>   *
>   * C struct representation of the video parameter set NAL unit as defined by
> @@ -129,7 +129,7 @@ struct nal_hevc_hrd_parameters {
>  	};
>  };
> 
> -/**
> +/*
>   * struct nal_hevc_vui_parameters - VUI parameters
>   *
>   * C struct representation of the VUI parameters as defined by Rec. ITU-T
> @@ -192,7 +192,7 @@ struct nal_hevc_vui_parameters {
>  	};
>  };
> 
> -/**
> +/*
>   * struct nal_hevc_sps - Sequence parameter set
>   *
>   * C struct representation of the video parameter set NAL unit as defined by
>
diff mbox series

Patch

diff --git a/drivers/media/platform/allegro-dvt/nal-h264.h b/drivers/media/platform/allegro-dvt/nal-h264.h
index 8cc5a28bf237..a19634fe8c0b 100644
--- a/drivers/media/platform/allegro-dvt/nal-h264.h
+++ b/drivers/media/platform/allegro-dvt/nal-h264.h
@@ -11,7 +11,7 @@ 
 #include <linux/kernel.h>
 #include <linux/types.h>

-/**
+/*
  * struct nal_h264_hrd_parameters - HRD parameters
  *
  * C struct representation of the sequence parameter set NAL unit as defined by
@@ -32,7 +32,7 @@  struct nal_h264_hrd_parameters {
 	unsigned int time_offset_length;
 };

-/**
+/*
  * struct nal_h264_vui_parameters - VUI parameters
  *
  * C struct representation of the VUI parameters as defined by Rec. ITU-T
@@ -87,7 +87,7 @@  struct nal_h264_vui_parameters {
 	};
 };

-/**
+/*
  * struct nal_h264_sps - Sequence parameter set
  *
  * C struct representation of the sequence parameter set NAL unit as defined by
@@ -142,7 +142,7 @@  struct nal_h264_sps {
 	struct nal_h264_vui_parameters vui;
 };

-/**
+/*
  * struct nal_h264_pps - Picture parameter set
  *
  * C struct representation of the picture parameter set NAL unit as defined by
diff --git a/drivers/media/platform/allegro-dvt/nal-hevc.h b/drivers/media/platform/allegro-dvt/nal-hevc.h
index fc994d4242d8..c09bbe5446aa 100644
--- a/drivers/media/platform/allegro-dvt/nal-hevc.h
+++ b/drivers/media/platform/allegro-dvt/nal-hevc.h
@@ -54,7 +54,7 @@  struct nal_hevc_profile_tier_level {
 	unsigned int general_level_idc;
 };

-/**
+/*
  * struct nal_hevc_vps - Video parameter set
  *
  * C struct representation of the video parameter set NAL unit as defined by
@@ -129,7 +129,7 @@  struct nal_hevc_hrd_parameters {
 	};
 };

-/**
+/*
  * struct nal_hevc_vui_parameters - VUI parameters
  *
  * C struct representation of the VUI parameters as defined by Rec. ITU-T
@@ -192,7 +192,7 @@  struct nal_hevc_vui_parameters {
 	};
 };

-/**
+/*
  * struct nal_hevc_sps - Sequence parameter set
  *
  * C struct representation of the video parameter set NAL unit as defined by