diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/ADCDevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/ADCDevice.h index 749a79b..5c74e4b 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/ADCDevice.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/ADCDevice.h @@ -1,6 +1,6 @@ // ----------------------------------------------------------------------------- -/// @file ADCDevice.h -/// @brief File description +/// \file ADCDevice.h +/// \brief File description // ----------------------------------------------------------------------------- // Micro-Key bv // Industrieweg 28, 9804 TG Noordhorn @@ -11,12 +11,16 @@ // Email: support@microkey.nl // Web: www.microkey.nl // ----------------------------------------------------------------------------- -/// $Revision: $ -/// $Author: $ -/// $Date: $ +/// $Revision$ +/// $Author$ +/// $Date$ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- + +#ifndef INC_ADCDEVICE_H_ +#define INC_ADCDEVICE_H_ + /** * ADCDevice implementation * \defgroup ADCDevice Package ADCDevice @@ -24,10 +28,6 @@ * @{ */ -#ifndef INC_ADCDEVICE_H_ -#define INC_ADCDEVICE_H_ - - // ----------------------------------------------------------------------------- // Include files // ----------------------------------------------------------------------------- @@ -43,12 +43,16 @@ struct ADCDevice; typedef uint32_t (*ADCReadFunction)(const struct ADCDevice* self); - +/** + * \ingroup ADCDevice + * \class ADCDevice + * The ADCDevice struct that can be used as an object + */ struct ADCDevice { - ADCReadFunction _read; - bool initialized; - unsigned int resolutionInBits; + ADCReadFunction _read; //!< ADCReadFunction() function pointer + bool initialized; //!< Flag indicating initialisation status + unsigned int resolutionInBits; //!< This ADCs resolution in number of bits }; // ----------------------------------------------------------------------------- @@ -56,50 +60,60 @@ struct ADCDevice // ----------------------------------------------------------------------------- -/** ---------------------------------------------------------------------------- - * ADCDevice_construct - * Constructor for ADC device +/** ADCDevice_construct + * \brief Constructor for a new ADC device * - * @param self ADC object - * @param read Pointer to read function - * @param resolutionsInBits The resolution of this ADC device in + * This is a detailed description of the function + * + * \memberof ADCDevice + * + * \param self ADC object + * \param[in] read Pointer to read function + * \param[in] resolutionsInBits The resolution of this ADC device in * number of bits * - * @return ErrorStatus SUCCESS if construction was successful + * \return ErrorStatus SUCCESS if construction was successful * ERROR otherwise * - * @todo - * ----------------------------------------------------------------------------- + * \todo + * */ extern ErrorStatus ADCDevice_construct(struct ADCDevice* self, ADCReadFunction read, unsigned int resolutionInBits); -/** ---------------------------------------------------------------------------- - * ADCDevice_destruct - * Destructor for ADC device +/** ADCDevice_destruct + * \brief Destructor for ADC device * - * @param self ADC object + * This is a detailed description of the function * - * @return void + * \memberof ADCDevice + * + * \param self ADC object + * + * \return void + * + * \todo * - * @todo - * ----------------------------------------------------------------------------- */ extern void ADCDevice_destruct(struct ADCDevice* self); -/** ---------------------------------------------------------------------------- - * ADCDevice_read - * Reads a value from the ADC device input +/** ADCDevice_read + * \brief Reads a value from the ADC device input + * This is a detailed description of the function * - * @param self ADC object + * \memberof ADCDevice * - * @return uint32_t The current value read from the ADC + * \param self ADC object + * + * \return uint32_t The current value read from the ADC + * + * \todo * - * @todo - * ----------------------------------------------------------------------------- */ extern uint32_t ADCDevice_read(const struct ADCDevice* self); +/** @} */ + #endif /* INC_ADCDEVICE_H_ */ -/** @} */ +