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 ++++--- 4 files changed, 11 insertions(+), 14 deletions(-) (limited to 'libmaple/include/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 -- cgit v1.2.3