From 2891f7d645c4be187ac96ee4011207531d25c34a Mon Sep 17 00:00:00 2001 From: gdisirio Date: Mon, 4 Oct 2010 17:16:18 +0000 Subject: Documentation improvements, fixed a small error in the STM32 serial driver. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2234 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/hal/include/mmc_spi.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'os/hal/include/mmc_spi.h') diff --git a/os/hal/include/mmc_spi.h b/os/hal/include/mmc_spi.h index cc698c3de..6af424d29 100644 --- a/os/hal/include/mmc_spi.h +++ b/os/hal/include/mmc_spi.h @@ -181,11 +181,23 @@ typedef struct { /** * @brief Returns the driver state. + * + * @param[in] mmcp pointer to the @p MMCDriver object + * @return The driver state. + * + * @api */ #define mmcGetDriverState(mmcp) ((mmcp)->mmc_state) /** * @brief Returns the write protect status. + * + * @param[in] mmcp pointer to the @p MMCDriver object + * @return The card state. + * @retval FALSE card not inserted. + * @retval TRUE card inserted. + * + * @api */ #define mmcIsWriteProtected(mmcp) ((mmcp)->mmc_is_protected()) -- cgit v1.2.3