private/hsb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen documentation tryouts and file SVN properties

Browse Source 
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@422 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
mmi
2018-01-12 09:22:52 +00:00
parent e3a3273e81
commit ed3b53ce32
1 changed files with 51 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/ADCDevice.h
View File

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