From bf531fa24a77bfe155f72bc564c9738fa5760a85 Mon Sep 17 00:00:00 2001
From: raiden00pl <raiden00@railab.me>
Date: Tue, 14 Mar 2023 14:18:04 +0100
Subject: [PATCH] arch/nrf52/gpiote: fix doc strings

---
 arch/arm/src/nrf52/nrf52_gpiote.c | 24 ++++--------------------
 arch/arm/src/nrf52/nrf52_gpiote.h | 23 +++++------------------
 2 files changed, 9 insertions(+), 38 deletions(-)

diff --git a/arch/arm/src/nrf52/nrf52_gpiote.c b/arch/arm/src/nrf52/nrf52_gpiote.c
index 8cd81fdf2d..e3a5b6e21d 100644
--- a/arch/arm/src/nrf52/nrf52_gpiote.c
+++ b/arch/arm/src/nrf52/nrf52_gpiote.c
@@ -246,10 +246,6 @@ static int nrf52_gpiote_isr(int irq, void *context, void *arg)
  *  - func:        When non-NULL, generate interrupt
  *  - arg:         Argument passed to the interrupt callback
  *
- * Returned Value:
- *   Zero (OK) on success; a negated errno value on failure indicating the
- *   nature of the failure.
- *
  ****************************************************************************/
 
 void nrf52_gpiote_set_pin_event(uint32_t pinset, xcpt_t func, void *arg)
@@ -285,10 +281,6 @@ void nrf52_gpiote_set_pin_event(uint32_t pinset, xcpt_t func, void *arg)
  *  - func:        When non-NULL, generate interrupt
  *  - arg:         Argument passed to the interrupt callback
  *
- * Returned Value:
- *   Zero (OK) on success; a negated errno value on failure indicating the
- *   nature of the failure.
- *
  ****************************************************************************/
 
 void nrf52_gpiote_set_port_event(uint32_t pinset, xcpt_t func, void *arg)
@@ -350,16 +342,12 @@ void nrf52_gpiote_set_port_event(uint32_t pinset, xcpt_t func, void *arg)
  *
  * Input Parameters:
  *  - pinset:      GPIO pin configuration
+ *  - channel:     GPIOTE channel used to capture events
  *  - risingedge:  Enables interrupt on rising edges
  *  - fallingedge: Enables interrupt on falling edges
- *  - event:       Generate event when set
  *  - func:        When non-NULL, generate interrupt
  *  - arg:         Argument passed to the interrupt callback
  *
- * Returned Value:
- *   Zero (OK) on success; a negated errno value on failure indicating the
- *   nature of the failure.
- *
  ****************************************************************************/
 
 void nrf52_gpiote_set_ch_event(uint32_t pinset, int channel,
@@ -456,14 +444,10 @@ void nrf52_gpiote_set_ch_event(uint32_t pinset, int channel,
  *   Finally, a given pin should only be assigned to a given channel.
  *
  * Input Parameters:
- *  - pinset: gpio pin configuration (only port + pin is important here)
- *  - channel: the GPIOTE channel used to control the given pin
+ *  - pinset:      gpio pin configuration (only port + pin is important here)
+ *  - channel:     the GPIOTE channel used to control the given pin
  *  - output_high: set pin initially to output HIGH or LOW.
- *  - outcfg: configure pin behavior one OUT task is triggered
- *
- * Returned Value:
- *   Zero (OK) on success; a negated errno value on failure indicating the
- *   nature of the failure.
+ *  - outcfg:      configure pin behavior one OUT task is triggered
  *
  ****************************************************************************/
 
diff --git a/arch/arm/src/nrf52/nrf52_gpiote.h b/arch/arm/src/nrf52/nrf52_gpiote.h
index 329c09c324..a7f61769b0 100644
--- a/arch/arm/src/nrf52/nrf52_gpiote.h
+++ b/arch/arm/src/nrf52/nrf52_gpiote.h
@@ -57,16 +57,12 @@ enum nrf52_gpiote_outcfg_e
  *
  * Input Parameters:
  *  - pinset:      GPIO pin configuration
+ *  - channel:     GPIOTE channel used to capture events
  *  - risingedge:  Enables interrupt on rising edges
  *  - fallingedge: Enables interrupt on falling edges
- *  - event:       Generate event when set
  *  - func:        When non-NULL, generate interrupt
  *  - arg:         Argument passed to the interrupt callback
  *
- * Returned Value:
- *   Zero (OK) on success; a negated errno value on failure indicating the
- *   nature of the failure.
- *
  ****************************************************************************/
 
 void nrf52_gpiote_set_ch_event(uint32_t pinset, int channel,
@@ -115,14 +111,9 @@ void nrf52_gpiote_set_pin_event(uint32_t pinset, xcpt_t func, void *arg);
  *  - func:        When non-NULL, generate interrupt
  *  - arg:         Argument passed to the interrupt callback
  *
- * Returned Value:
- *   Zero (OK) on success; a negated errno value on failure indicating the
- *   nature of the failure.
- *
  ****************************************************************************/
 
-void nrf52_gpiote_set_port_event(uint32_t pinset, xcpt_t func,
-                                 void *arg);
+void nrf52_gpiote_set_port_event(uint32_t pinset, xcpt_t func, void *arg);
 
 #endif
 
@@ -138,14 +129,10 @@ void nrf52_gpiote_set_port_event(uint32_t pinset, xcpt_t func,
  *   Finally, a given pin should only be assigned to a given channel.
  *
  * Input Parameters:
- *  - pinset: gpio pin configuration (only port + pin is important here)
- *  - channel: the GPIOTE channel used to control the given pin
+ *  - pinset:      gpio pin configuration (only port + pin is important here)
+ *  - channel:     the GPIOTE channel used to control the given pin
  *  - output_high: set pin initially to output HIGH or LOW.
- *  - outcfg: configure pin behavior one OUT task is triggered
- *
- * Returned Value:
- *   Zero (OK) on success; a negated errno value on failure indicating the
- *   nature of the failure.
+ *  - outcfg:      configure pin behavior one OUT task is triggered
  *
  ****************************************************************************/