From 6a6af3980a827a02e371968ec56271774ceb26ac Mon Sep 17 00:00:00 2001 From: Marti Bolivar Date: Thu, 28 Jun 2012 17:27:05 -0400 Subject: Doxygen hacks and fixups. - Shut Doxygen up in various places - Fix some genuine docs bugs - Ignore sources we're not responsible for Signed-off-by: Marti Bolivar --- libmaple/include/libmaple/dma.h | 2 +- libmaple/include/libmaple/dma_common.h | 8 +++----- libmaple/include/libmaple/i2c_common.h | 8 +++----- libmaple/include/libmaple/spi.h | 7 ++++--- libmaple/stm32f1/include/series/i2c.h | 2 +- libmaple/stm32f2/include/series/gpio.h | 2 +- libmaple/usb/stm32f1/usb.c | 2 +- libmaple/usb/stm32f1/usb_cdcacm.c | 2 +- 8 files changed, 15 insertions(+), 18 deletions(-) (limited to 'libmaple') diff --git a/libmaple/include/libmaple/dma.h b/libmaple/include/libmaple/dma.h index 0b1ec4c..e22cdaf 100644 --- a/libmaple/include/libmaple/dma.h +++ b/libmaple/include/libmaple/dma.h @@ -294,7 +294,7 @@ extern void dma_set_mem_addr(dma_dev *dev, dma_tube tube, __io void *address); * * @param dev DMA Device * @param tube Tube whose peripheral data register base address to set. - * @param addr Peripheral memory base address to use. + * @param address Peripheral memory base address to use. */ extern void dma_set_per_addr(dma_dev *dev, dma_tube tube, __io void *address); diff --git a/libmaple/include/libmaple/dma_common.h b/libmaple/include/libmaple/dma_common.h index 67475f7..3765cd5 100644 --- a/libmaple/include/libmaple/dma_common.h +++ b/libmaple/include/libmaple/dma_common.h @@ -29,11 +29,9 @@ * @author Marti Bolivar * @brief Common DMA sub-header for and . * - * WARNING: CONTENTS UNSTABLE - * - * The existence of this file is an implementation detail. Its - * contents are not stable, so never include it directly. If you need - * something from here, #include instead. + * CONTENTS UNSTABLE. The existence of this file is an implementation + * detail. Never include it directly. If you need something from + * here, include instead. */ /* diff --git a/libmaple/include/libmaple/i2c_common.h b/libmaple/include/libmaple/i2c_common.h index 5d99530..17cabe3 100644 --- a/libmaple/include/libmaple/i2c_common.h +++ b/libmaple/include/libmaple/i2c_common.h @@ -30,11 +30,9 @@ * @author Marti Bolivar * @brief This file is an implementation detail * - * WARNING: CONTENTS UNSTABLE - * - * The existence of this file is an implementation detail. Its - * contents are not stable, so never include it directly. If you need - * something from here, #include instead. + * CONTENTS UNSTABLE. The existence of this file is an implementation + * detail. Never include it directly. If you need something from + * here, include instead. */ #ifndef _LIBMAPLE_I2C_COMMON_H_ diff --git a/libmaple/include/libmaple/spi.h b/libmaple/include/libmaple/spi.h index fab643f..4acd230 100644 --- a/libmaple/include/libmaple/spi.h +++ b/libmaple/include/libmaple/spi.h @@ -215,11 +215,12 @@ void spi_init(spi_dev *dev); struct gpio_dev; /** * @brief Configure GPIO bit modes for use as a SPI port's pins. - * @param as_master If true, configure bits for use as a bus master. - * Otherwise, configure bits for use as slave. + * + * @param dev SPI device + * @param as_master If true, configure as bus master; otherwise, as slave. * @param nss_dev NSS pin's GPIO device - * @param comm_dev SCK, MISO, MOSI pins' GPIO device * @param nss_bit NSS pin's GPIO bit on nss_dev + * @param comm_dev SCK, MISO, MOSI pins' GPIO device * @param sck_bit SCK pin's GPIO bit on comm_dev * @param miso_bit MISO pin's GPIO bit on comm_dev * @param mosi_bit MOSI pin's GPIO bit on comm_dev diff --git a/libmaple/stm32f1/include/series/i2c.h b/libmaple/stm32f1/include/series/i2c.h index a0822e8..f407955 100644 --- a/libmaple/stm32f1/include/series/i2c.h +++ b/libmaple/stm32f1/include/series/i2c.h @@ -26,7 +26,7 @@ *****************************************************************************/ /** - * @file libmaple/include/stm32f1/include/series/i2c.h + * @file libmaple/stm32f1/include/series/i2c.h * @brief STM32F1 I2C */ diff --git a/libmaple/stm32f2/include/series/gpio.h b/libmaple/stm32f2/include/series/gpio.h index 1496e8e..4d0d98c 100644 --- a/libmaple/stm32f2/include/series/gpio.h +++ b/libmaple/stm32f2/include/series/gpio.h @@ -222,7 +222,7 @@ void gpio_set_modef(struct gpio_dev *dev, * default speed. * * @param dev GPIO device. - * @param pin Pin on the device whose mode to set, 0--15. + * @param bit Bit on the device whose mode to set, 0--15. * @param mode Mode to set the pin to. */ static inline void gpio_set_mode(struct gpio_dev *dev, diff --git a/libmaple/usb/stm32f1/usb.c b/libmaple/usb/stm32f1/usb.c index 0130bab..c20cc71 100644 --- a/libmaple/usb/stm32f1/usb.c +++ b/libmaple/usb/stm32f1/usb.c @@ -25,7 +25,7 @@ *****************************************************************************/ /** - * @file libmaple/usb/usb.c + * @file libmaple/usb/stm32f1/usb.c * @brief USB support. * * This is a mess. What we need almost amounts to a ground-up rewrite. diff --git a/libmaple/usb/stm32f1/usb_cdcacm.c b/libmaple/usb/stm32f1/usb_cdcacm.c index 6ef4806..6a8235e 100644 --- a/libmaple/usb/stm32f1/usb_cdcacm.c +++ b/libmaple/usb/stm32f1/usb_cdcacm.c @@ -25,7 +25,7 @@ *****************************************************************************/ /** - * @file libmaple/usb/usb_cdcacm.c + * @file libmaple/usb/stm32f1/usb_cdcacm.c * @brief USB CDC ACM (a.k.a. virtual serial terminal, VCOM). * * FIXME: this works on the STM32F1 USB peripherals, and probably no -- cgit v1.2.3