doxygen fixes

ugfx_release_2.6
Joel Bodenmann 2013-03-10 20:17:24 +01:00
parent 2088f0fe67
commit 426a12de6b
10 changed files with 34 additions and 21 deletions

View File

@ -18,7 +18,7 @@
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
/** /**
* @file include/gadc/lld/gadc_lld.c * @file drivers/gadc/AT91SAM7/gadc_lld.c
* @brief GADC - Periodic ADC driver source file for the AT91SAM7 cpu. * @brief GADC - Periodic ADC driver source file for the AT91SAM7 cpu.
* *
* @defgroup Driver Driver * @defgroup Driver Driver

View File

@ -18,7 +18,7 @@
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
/** /**
* @file drivers/gaudin/gadc/gaudin.c * @file drivers/gaudin/gadc/gaudin_lld.c
* @brief GAUDIN - Driver file for using the cpu ADC (via GADC). * @brief GAUDIN - Driver file for using the cpu ADC (via GADC).
* *
* @addtogroup GAUDIN * @addtogroup GAUDIN

View File

@ -19,7 +19,7 @@
*/ */
/** /**
* @file drivers/tdisp/HD44780/tdisp_lld_board_unknown.h * @file drivers/tdisp/HD44780/tdisp_lld_board_olimex_e407.h
* @brief TDISP driver subsystem board interface for the HD44780 display * @brief TDISP driver subsystem board interface for the HD44780 display
* *
* @addtogroup TDISP * @addtogroup TDISP

View File

@ -19,7 +19,7 @@
*/ */
/** /**
* @file drivers/tdisp/HD44780/tdisp_lld_board_unknown.h * @file drivers/tdisp/HD44780/tdisp_lld_board_st_stm32f4_discovery.h
* @brief TDISP driver subsystem board interface for the HD44780 display * @brief TDISP driver subsystem board interface for the HD44780 display
* *
* @addtogroup TDISP * @addtogroup TDISP

View File

@ -93,7 +93,8 @@ typedef struct GEventADC_t {
* @brief The buffer containing the conversion samples * @brief The buffer containing the conversion samples
*/ */
adcsample_t *buffer; adcsample_t *buffer;
} GEventADC; } GEventADC;
/** @} */
/** /**
* @brief A callback function (executed in a thread context) for a low speed conversion * @brief A callback function (executed in a thread context) for a low speed conversion
@ -117,11 +118,11 @@ extern "C" {
* @brief Initialise the high speed ADC. * @brief Initialise the high speed ADC.
* @details Initialises but does not start the conversions. * @details Initialises but does not start the conversions.
* *
* @param[in] physdev A value passed to describe which physical ADC devices/channels to use. * @param[in] physdev A value passed to describe which physical ADC devices/channels to use.
* @param[in] frequency The frequency to create ADC conversions * @param[in] frequency The frequency to create ADC conversions
* @param[in] buffer The static buffer to put the ADC samples into. * @param[in] buffer The static buffer to put the ADC samples into.
* @param[in] bufcount The total number of conversions that will fit in the buffer. * @param[in] bufcount The total number of conversions that will fit in the buffer.
* @param[in] countPerEvent The number of conversions to do before returning an event. * @param[in] samplesPerEvent The number of conversions to do before returning an event.
* *
* @note If the high speed ADC is running it will be stopped. The Event subsystem is * @note If the high speed ADC is running it will be stopped. The Event subsystem is
* disconnected from the high speed ADC and any binary semaphore event is forgotten. * disconnected from the high speed ADC and any binary semaphore event is forgotten.
@ -166,6 +167,8 @@ void gadcHighSpeedInit(uint32_t physdev, uint32_t frequency, adcsample_t *buffer
* @note The high speed ADC is capable of signalling via this method, an ISR callback and a * @note The high speed ADC is capable of signalling via this method, an ISR callback and a
* binary semaphore at the same time. * binary semaphore at the same time.
* *
* @return The GSourceHandle
*
* @api * @api
*/ */
GSourceHandle gadcHighSpeedGetSource(void); GSourceHandle gadcHighSpeedGetSource(void);
@ -249,6 +252,8 @@ void gadcLowSpeedGet(uint32_t physdev, adcsample_t *buffer);
* @param[in] fn The callback function to call when the conversion is complete. * @param[in] fn The callback function to call when the conversion is complete.
* @param[in] param A parameter to pass to the callback function. * @param[in] param A parameter to pass to the callback function.
* *
* @return FALSE if no free low speed ADC slots.
*
* @note This may be safely called from within a GTimer callback. * @note This may be safely called from within a GTimer callback.
* @note The callback may take a while to occur if the high speed ADC is running as the * @note The callback may take a while to occur if the high speed ADC is running as the
* conversion is interleaved with the high speed ADC conversions on a buffer * conversion is interleaved with the high speed ADC conversions on a buffer

View File

@ -103,11 +103,12 @@ void gadc_lld_init(void);
* @brief Get the number of samples in a conversion. * @brief Get the number of samples in a conversion.
* @details Calculates and returns the number of samples per conversion for the specified physdev. * @details Calculates and returns the number of samples per conversion for the specified physdev.
* *
* @param[in] physdev A value passed to describe which physical ADC devices/channels to use.
*
* @note A physdev describing a mono device would return 1, a stereo device would return 2. * @note A physdev describing a mono device would return 1, a stereo device would return 2.
* For most ADC's physdev is a bitmap so it is only a matter of counting the bits. * For most ADC's physdev is a bitmap so it is only a matter of counting the bits.
* *
* @param[in] physdev A value passed to describe which physical ADC devices/channels to use.
*
* @return Number of samples of the convesion
* @api * @api
*/ */
size_t gadc_lld_samples_per_conversion(uint32_t physdev); size_t gadc_lld_samples_per_conversion(uint32_t physdev);

View File

@ -76,7 +76,8 @@ typedef struct GEventAudioIn_t {
* @brief The buffer containing the audio samples * @brief The buffer containing the audio samples
*/ */
audin_sample_t *buffer; audin_sample_t *buffer;
} GEventAudioIn; } GEventAudioIn;
/** @} */
/*===========================================================================*/ /*===========================================================================*/
/* External declarations. */ /* External declarations. */
@ -90,11 +91,11 @@ extern "C" {
* @brief Initialise (but not start) the Audio Input Subsystem. * @brief Initialise (but not start) the Audio Input Subsystem.
* @details Returns FALSE for an invalid channel or other invalid parameter. * @details Returns FALSE for an invalid channel or other invalid parameter.
* *
* @param[in] channel The channel to convert. Can be set from 0 to GAUDIN_NUM_CHANNELS - 1. * @param[in] channel The channel to convert. Can be set from 0 to GAUDIN_NUM_CHANNELS - 1.
* @param[in] frequency The sample frequency * @param[in] frequency The sample frequency
* @param[in] buffer The static buffer to put the samples into. * @param[in] buffer The static buffer to put the samples into.
* @param[in] bufcount The total number of conversions that will fit in the buffer. * @param[in] bufcount The total number of conversions that will fit in the buffer.
* @param[in] countPerEvent The number of conversions to do before returning an event. * @param[in] samplesPerEvent The number of conversions to do before returning an event.
* *
* @note Only one channel is active at a time. If an audio input is running it will be stopped. * @note Only one channel is active at a time. If an audio input is running it will be stopped.
* The Event subsystem is disconnected from the audio subsystem and any binary semaphore * The Event subsystem is disconnected from the audio subsystem and any binary semaphore
@ -119,6 +120,8 @@ extern "C" {
* a block of samples containing less than countPerEvent samples when it reaches the * a block of samples containing less than countPerEvent samples when it reaches the
* end of the buffer. * end of the buffer.
* *
* @return FALSE if invalid channel or parameter
*
* @api * @api
*/ */
bool_t gaudinInit(uint16_t channel, uint32_t frequency, audin_sample_t *buffer, size_t bufcount, size_t samplesPerEvent); bool_t gaudinInit(uint16_t channel, uint32_t frequency, audin_sample_t *buffer, size_t bufcount, size_t samplesPerEvent);
@ -135,6 +138,8 @@ bool_t gaudinInit(uint16_t channel, uint32_t frequency, audin_sample_t *buffer,
* @note The audio input is capable of signalling via this method and a binary semaphore * @note The audio input is capable of signalling via this method and a binary semaphore
* at the same time. * at the same time.
* *
* @return The GSourceHandle
*
* @api * @api
*/ */
GSourceHandle gaudinGetSource(void); GSourceHandle gaudinGetSource(void);

View File

@ -50,14 +50,15 @@ typedef struct gaudin_params_t {
size_t bufcount; size_t bufcount;
size_t samplesPerEvent; size_t samplesPerEvent;
} gaudin_params; } gaudin_params;
/* @} */ /** @} */
/** /**
* @brief These routines are the callbacks that the driver uses. * @brief These routines are the callbacks that the driver uses.
* @details Defined in the high level GAUDIN code. * @details Defined in the high level GAUDIN code.
* *
* @icode * @iclass
* @notapi * @notapi
*
* @{ * @{
*/ */
extern void GAUDIN_ISR_CompleteI(audin_sample_t *buffer, size_t n); extern void GAUDIN_ISR_CompleteI(audin_sample_t *buffer, size_t n);

View File

@ -735,7 +735,7 @@ void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color);
* @param[in] str The string to draw * @param[in] str The string to draw
* @param[in] font The font to use * @param[in] font The font to use
* @param[in] color The color to use * @param[in] color The color to use
* @param[in] bgcolor The background color to use * @param[in] bgColor The background color to use
* @param[in] justify Justify the text left, center or right within the box * @param[in] justify Justify the text left, center or right within the box
* *
* @api * @api

View File

@ -212,6 +212,7 @@ void gwinSetButtonCustom(GHandle gh, GButtonDrawFunction fn, void *param);
* *
* @param[in] gh The button handle * @param[in] gh The button handle
* @param[in] isdown Is the button currently down (depressed) * @param[in] isdown Is the button currently down (depressed)
* @param[in] txt The text to be display inside the button
* @param[in] pstyle The current drawing style for the state we are in * @param[in] pstyle The current drawing style for the state we are in
* @param[in] param A parameter passed in from the user * @param[in] param A parameter passed in from the user
* *