From 34f2b3e6f9c5b09de1d30b89f3c3ffd969c72873 Mon Sep 17 00:00:00 2001 From: Yannick Gicquel Date: Wed, 28 Feb 2018 19:13:06 +0100 Subject: [PATCH] drivers/qdec: doxygen rendering fixes Signed-off-by: Yannick Gicquel --- drivers/include/periph/qdec.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/drivers/include/periph/qdec.h b/drivers/include/periph/qdec.h index aa7f06ff3c..225e9ec779 100644 --- a/drivers/include/periph/qdec.h +++ b/drivers/include/periph/qdec.h @@ -21,6 +21,8 @@ * A quadrature encoder outputs two wave forms that are 90 degrees * out of phase. * + * @verbatim + * * Clockwise (C) : Counter-clockwise (CC) : * ___________________ ___________________ * | Phase | A | B | | Phase | A | B | @@ -50,11 +52,12 @@ * 6. Rising edge on B and signal A is down => (CC) => increment counter * 7. Falling edge on B and signal A is up => (C) => increment counter * 8. Falling edge on B and signal A is down => (CC) => decrement counter + * @endverbatim * * According to these cases, three modes are available : - * X1 mode : signal A, rising edges (cases 1 and 2) - * X2 mode : signal A, rising and falling edges (cases 1, 2, 3 and 4) - * X4 mode : signals A and B, rising and falling edges (all cases) + * - X1 mode : signal A, rising edges (cases 1 and 2) + * - X2 mode : signal A, rising and falling edges (cases 1, 2, 3 and 4) + * - X4 mode : signals A and B, rising and falling edges (all cases) * * The mapping/configuration of QDEC devices (timers) and the used pins has to be * done in the board configuration (the board's `periph_conf.h).