Performed some doxygen updates

git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@423 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
mmi
2018-01-12 12:59:03 +00:00
parent ed3b53ce32
commit 7f42b00161
4 changed files with 168 additions and 150 deletions

View File

@@ -23,7 +23,7 @@
/**
* ADCDevice implementation
* \defgroup ADCDevice Package ADCDevice
* \defgroup ADCDevice ADCDevice
* \ingroup HAL
* @{
*/
@@ -41,6 +41,7 @@
struct ADCDevice;
typedef uint32_t (*ADCReadFunction)(const struct ADCDevice* self);
/**
@@ -59,41 +60,36 @@ struct ADCDevice
// Function declarations
// -----------------------------------------------------------------------------
/** ADCDevice_construct
* \brief Constructor for a new ADC device
*
* \brief Constructor for a new ADC device *
* This is a detailed description of the function
*
* Created by: mmi
* \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
* ERROR otherwise
*
* \todo
*
*/
extern ErrorStatus ADCDevice_construct(struct ADCDevice* self, ADCReadFunction read, unsigned int resolutionInBits);
/** ADCDevice_destruct
* \brief Destructor for ADC device
*
* This is a detailed description of the function
*
*Created by: mmi
* \memberof ADCDevice
*
* \param self ADC object
*
* \return void
*
* \todo
*
*/
extern void ADCDevice_destruct(struct ADCDevice* self);
@@ -101,14 +97,13 @@ extern void ADCDevice_destruct(struct ADCDevice* self);
* \brief Reads a value from the ADC device input
* This is a detailed description of the function
*
* Created by: mmi
* \memberof ADCDevice
*
* \param self ADC object
*
* \return uint32_t The current value read from the ADC
*
* \todo
*
*/
extern uint32_t ADCDevice_read(const struct ADCDevice* self);