[PATCH] ptp: clockmatrix: Start comments with '/*'

[PATCH] ptp: clockmatrix: Start comments with '/*'

[Simon Horman]

Several comments in idt8a340_reg.h start with '/**',
which denotes the start of a Kernel doc,
but are otherwise not Kernel docs.

Resolve this conflict by starting these comments with '/*' instead.

Flagged by ./scripts/kernel-doc -none

Signed-off-by: Simon Horman <horms@kernel.org>
---
 include/linux/mfd/idt8a340_reg.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/linux/mfd/idt8a340_reg.h b/include/linux/mfd/idt8a340_reg.h
index 0c706085c205..53a222605526 100644
--- a/include/linux/mfd/idt8a340_reg.h
+++ b/include/linux/mfd/idt8a340_reg.h
@@ -61,7 +61,7 @@
 #define HW_Q8_CTRL_SPARE  (0xa7d4)
 #define HW_Q11_CTRL_SPARE (0xa7ec)
 
-/**
+/*
  * Select FOD5 as sync_trigger for Q8 divider.
  * Transition from logic zero to one
  * sets trigger to sync Q8 divider.
@@ -70,7 +70,7 @@
  */
 #define Q9_TO_Q8_SYNC_TRIG  BIT(1)
 
-/**
+/*
  * Enable FOD5 as driver for clock and sync for Q8 divider.
  * Enable fanout buffer for FOD5.
  *
@@ -78,7 +78,7 @@
  */
 #define Q9_TO_Q8_FANOUT_AND_CLOCK_SYNC_ENABLE_MASK  (BIT(0) | BIT(2))
 
-/**
+/*
  * Select FOD6 as sync_trigger for Q11 divider.
  * Transition from logic zero to one
  * sets trigger to sync Q11 divider.
@@ -87,7 +87,7 @@
  */
 #define Q10_TO_Q11_SYNC_TRIG  BIT(1)
 
-/**
+/*
  * Enable FOD6 as driver for clock and sync for Q11 divider.
  * Enable fanout buffer for FOD6.
  *

Re: [PATCH] ptp: clockmatrix: Start comments with '/*'

[Lee Jones]

Subject line should start with:

  "mfd: idt8a340_reg: "

On Sat, 04 May 2024, Simon Horman wrote:

> Several comments in idt8a340_reg.h start with '/**',
> which denotes the start of a Kernel doc,
> but are otherwise not Kernel docs.

Some very odd line breaking here.

> Resolve this conflict by starting these comments with '/*' instead.
> 
> Flagged by ./scripts/kernel-doc -none
> 
> Signed-off-by: Simon Horman <horms@kernel.org>
> ---
>  include/linux/mfd/idt8a340_reg.h | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/include/linux/mfd/idt8a340_reg.h b/include/linux/mfd/idt8a340_reg.h
> index 0c706085c205..53a222605526 100644
> --- a/include/linux/mfd/idt8a340_reg.h
> +++ b/include/linux/mfd/idt8a340_reg.h
> @@ -61,7 +61,7 @@
>  #define HW_Q8_CTRL_SPARE  (0xa7d4)
>  #define HW_Q11_CTRL_SPARE (0xa7ec)
>  
> -/**
> +/*
>   * Select FOD5 as sync_trigger for Q8 divider.
>   * Transition from logic zero to one
>   * sets trigger to sync Q8 divider.
> @@ -70,7 +70,7 @@
>   */
>  #define Q9_TO_Q8_SYNC_TRIG  BIT(1)
>  
> -/**
> +/*
>   * Enable FOD5 as driver for clock and sync for Q8 divider.
>   * Enable fanout buffer for FOD5.
>   *
> @@ -78,7 +78,7 @@
>   */
>  #define Q9_TO_Q8_FANOUT_AND_CLOCK_SYNC_ENABLE_MASK  (BIT(0) | BIT(2))
>  
> -/**
> +/*
>   * Select FOD6 as sync_trigger for Q11 divider.
>   * Transition from logic zero to one
>   * sets trigger to sync Q11 divider.
> @@ -87,7 +87,7 @@
>   */
>  #define Q10_TO_Q11_SYNC_TRIG  BIT(1)
>  
> -/**
> +/*
>   * Enable FOD6 as driver for clock and sync for Q11 divider.
>   * Enable fanout buffer for FOD6.
>   *
> 

-- 
Lee Jones [李琼斯]

Re: [PATCH] ptp: clockmatrix: Start comments with '/*'

[Simon Horman]

On Tue, May 07, 2024 at 09:43:36AM +0100, Lee Jones wrote:
> Subject line should start with:
> 
>   "mfd: idt8a340_reg: "
> 
> On Sat, 04 May 2024, Simon Horman wrote:
> 
> > Several comments in idt8a340_reg.h start with '/**',
> > which denotes the start of a Kernel doc,
> > but are otherwise not Kernel docs.
> 
> Some very odd line breaking here.

Thanks will up date this and the subject in a v2.

...