Fix typo and clarify doc in fpsensor.h and gpio.wrap

This also brings some minor Doxygen formatting to gpio.wrap.

BRANCH=none
BUG=chromium:991365
TEST=make buildall -j

Change-Id: Id6d85263b6ac472b0961240ebb266dd22591d68b
Signed-off-by: Craig Hesling <hesling@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1685772
Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>

2 files changed, 29 insertions, 11 deletions

diff --git a/include/fpsensor.h b/include/fpsensor.h
index bf1c8195ea..9a3d2c4e21 100644
--- a/include/fpsensor.h
+++ b/include/fpsensor.h
@@ -23,7 +23,7 @@
 /* 8-bit greyscale pixel format as defined by V4L2 headers */
 #define V4L2_PIX_FMT_GREY FOURCC('G', 'R', 'E', 'Y')
 
-/* --- fonctions provided by the sensor-specific driver --- */
+/* --- functions provided by the sensor-specific driver --- */
 
 /* Initialize the connected sensor hardware and put it in a low power mode. */
 int fp_sensor_init(void);
diff --git a/include/gpio.wrap b/include/gpio.wrap
index 1e018f2ed2..b68621d49c 100644
--- a/include/gpio.wrap
+++ b/include/gpio.wrap
@@ -5,6 +5,19 @@
  * found in the LICENSE file.
  */
 
+/**
+ * @file gpio.wrap
+ * @brief Include the board specific *gpio.inc* file.
+ *
+ * This file is included in many different contexts.
+ * The macros defined outside of the file (before including)
+ * determine what parts of *gpio.inc* will be emitted.
+ *
+ * @see include/gpio_list.h
+ * @see common/gpio.c
+ * @see include/gpio_signal.h
+ */
+
 #ifndef GPIO_PIN
 #error "Your architecture must define GPIO_PIN and it did not."
 #endif
@@ -13,8 +26,9 @@
 #error "Your architecture must define GPIO_PIN_MASK and it did not."
 #endif
 
-/*
- * The GPIO macro is used to define a new GPIO pin name and function.
+/**
+ * @def GPIO
+ * @brief The GPIO macro is used to define a new GPIO pin name and function.
  *
  * The name is used to populate the gpio_signal enum by first
  * prepending GPIO_ to the name.  It is also used to construct the
@@ -27,8 +41,9 @@
 #define GPIO(name, pin, flags)
 #endif
 
-/*
- * The GPIO_INT macro is used to define a GPIOs that have an IRQ handler.
+/**
+ * @def GPIO_INT
+ * @brief The GPIO_INT macro is used to define a GPIOs that have an IRQ handler.
  *
  * The IRQ handler pointers are stored as elements in the gpio_irq_handlers
  * array.
@@ -37,8 +52,10 @@
 #define GPIO_INT(name, pin, flags, signal)
 #endif
 
-/*
- * The ALTERNATE macro is used associate a GPIO with an alternate function.
+/**
+ * @def ALTERNATE
+ * @brief The ALTERNATE macro is used associate a GPIO with an alternate
+ *        function.
  *
  * Alternate functions allow hardware peripherals access to GPIO pins.
  * Modules use gpio_config_module to enable and disable the alternate functions
@@ -54,8 +71,9 @@
 #define ALTERNATE(pinmask, function, module, flags)
 #endif
 
-/*
- * The UNIMPLEMENTED macro is used to define a GPIO that doesn't actually exist.
+/**
+ * @def UNIMPLEMENTED
+ * @brief The UNIMPLEMENTED macro is used to define a GPIO that doesn't actually exist.
  *
  * Some GPIO names are well known and used by generic code, ENTERING_RW and WP_L
  * are examples.  If a particular board doesn't have a GPIO assigned to such a
@@ -77,8 +95,8 @@
  * RO/RW pin macro.
  *
  * Some boards may have very different pin configurations between RO and RW, and
- * also may vary from revisions to revisions. The RO/RW pin macros can ease the
- * maintance effort.
+ * also may vary from revision to revision. The RO/RW pin macros can ease the
+ * maintenance effort.
  */
 
 #ifdef SECTION_IS_RO