From cfb55967c76a9baba4420df411ae09189fae2ae9 Mon Sep 17 00:00:00 2001 From: dvl Date: Mon, 15 Jan 2018 11:40:43 +0000 Subject: [PATCH] Doxygen update git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@428 05563f52-14a8-4384-a975-3d1654cca0fa --- .../0 - Code/HAL/inc/DACDevice.h | 4 ++ .../0 - Code/HAL/inc/DisplayDevice.h | 14 +++++++ .../0 - Code/HAL/inc/IODevice.h | 3 ++ .../0 - Code/HAL/inc/Interlock.h | 4 ++ .../0 - Code/HAL/inc/KeyboardDevice.h | 6 +++ .../0 - Code/HAL/inc/Logger.h | 37 ++++++++++++++++++- .../0 - Code/HAL/inc/MAX5715.h | 5 +++ .../0 - Code/HAL/inc/MemoryDevice.h | 5 +++ .../0 - Code/HAL/inc/Observable.h | 8 ++++ .../3 - Implementation/0 - Code/HAL/inc/PID.h | 4 ++ .../0 - Code/HAL/inc/nhd0420.h | 19 ++++++++++ .../0 - Code/HAL/inc/storm700.h | 3 ++ 12 files changed, 111 insertions(+), 1 deletion(-) diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DACDevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DACDevice.h index d182561..8d24415 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DACDevice.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DACDevice.h @@ -70,6 +70,7 @@ struct DACDevice * DACDevice_construct * Constructor for DAC device * + * @memberof DACDevice * @param self DAC object * @param write Pointer to write function * @param readback Pointer to value readback function @@ -89,6 +90,7 @@ extern ErrorStatus DACDevice_construct(struct DACDevice* self, DACWriteFunction * DACDevice_destruct * Destructor for DAC device * + * @memberof DACDevice * @param self DAC object * * @return void @@ -102,6 +104,7 @@ extern void DACDevice_destruct(struct DACDevice* self); * DACDevice_construct * Writes a value to the DAC device output * + * @memberof DACDevice * @param self DAC object * @param voltage value to write to output * @@ -117,6 +120,7 @@ extern ErrorStatus DACDevice_write(const struct DACDevice* self, uint32_t voltag * DACDevice_getCurrentValue * returns the currently applied value from the DAC * + * @memberof DACDevice * @param self DAC object * * @return uint32_t The value that is currently applied to diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DisplayDevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DisplayDevice.h index 8af2825..dc62c46 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DisplayDevice.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DisplayDevice.h @@ -107,6 +107,7 @@ struct DisplayDevice * If a specific function is not implemented at the display device it is valid * to use NULL pointer instead * + * @memberof DisplayDevice * @param self The device instance * @param parameters Parameters for the display device * @param reset Pointer to DISPLAY RESET function @@ -151,6 +152,7 @@ extern ErrorStatus DisplayDevice_construct (struct DisplayDevice* self, struct D * DisplayDevice_destruct * Destructor for Display Device * + * @memberof DisplayDevice * @param self The device instance to destruct * * @return void @@ -165,6 +167,7 @@ extern void DisplayDevice_destruct (struct DisplayDevice* self); * DisplayDevice_reset * RESET the complete display device * + * @memberof DisplayDevice * @param self The device instance * * @return ErrorStatus SUCCESS if function was successful @@ -181,6 +184,7 @@ extern ErrorStatus DisplayDevice_reset(const struct DisplayDevice* self); * Sets the display to new state * * + * @memberof DisplayDevice * @param self The device instance * @param state Can be either ON or OFF * @@ -198,6 +202,7 @@ extern ErrorStatus DisplayDevice_setState(const struct DisplayDevice* self, Disp * Display backspace function. Set cursor one position back and delete character * * + * @memberof DisplayDevice * @param self The device instance * * @return ErrorStatus SUCCESS if function was successful @@ -215,6 +220,7 @@ extern ErrorStatus DisplayDevice_backspace(const struct DisplayDevice* self); * DisplayDevice function in behind verifies the position * * + * @memberof DisplayDevice * @param self The device instance * @param row Row to use (starts with 1, not 0) * @param column Column to use (Starts with 1, not 0) @@ -235,6 +241,7 @@ extern ErrorStatus DisplayDevice_setCursorToPosition(const struct DisplayDevice* * arguments row/column * * + * @memberof DisplayDevice * @param self The device instance * @param buffer Pointer to the character to write * @param row Row to use (starts with 1, not 0) @@ -254,6 +261,7 @@ extern ErrorStatus DisplayDevice_writeCharacter(const struct DisplayDevice* self * DisplayDevice_write * * + * @memberof DisplayDevice * @param self The device instance * @param buffer Pointer to the string to write * @param length The length (number in characters) of the @@ -277,6 +285,7 @@ extern ErrorStatus DisplayDevice_write(const struct DisplayDevice* self, const c * Function to clear the complete display * * + * @memberof DisplayDevice * @param self The device instance * * @return ErrorStatus SUCCESS if function was successful @@ -293,6 +302,7 @@ extern ErrorStatus DisplayDevice_clear(const struct DisplayDevice* self); * Function to clear the line given in argument row * * + * @memberof DisplayDevice * @param self The device instance * @param row Row to use (starts with 1, not 0) * @@ -313,6 +323,7 @@ extern ErrorStatus DisplayDevice_clearLine(const struct DisplayDevice* self, uns * parameters in the constructor * * + * @memberof DisplayDevice * @param self The device instance * @param brightness The brightness value * @@ -333,6 +344,7 @@ extern ErrorStatus DisplayDevice_setBrightness(const struct DisplayDevice* self, * Must be a value between the min and max contrast given in the display device * parameters in the constructor * + * @memberof DisplayDevice * @param self The device instance * @param contrast The contrast value * @@ -352,6 +364,7 @@ extern ErrorStatus DisplayDevice_setContrast(const struct DisplayDevice* self, u * Function to invert the display representation * * + * @memberof DisplayDevice * @param self The device instance * * @return ErrorStatus SUCCESS if function was successful @@ -368,6 +381,7 @@ extern ErrorStatus DisplayDevice_invert(const struct DisplayDevice* self); * Sets the state for a blinking cursor * * + * @memberof DisplayDevice * @param self The device instance * @param state Can either be ON or OFF * diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/IODevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/IODevice.h index 2250597..fa4bc59 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/IODevice.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/IODevice.h @@ -64,6 +64,7 @@ struct IODevice * IODevice_construct * Constructor for a new IO Device * + * @memberof IODevice * @param self IO Device instance to create * @param read Pointer to read function * @param write Pointer to write function @@ -81,6 +82,7 @@ extern ErrorStatus IODevice_construct (struct IODevice* self, ReadFunction read, * IODevice_write * Writes a character buffer to IO Device * + * @memberof IODevice * @param self IO Device instance to create * @param buffer The character string to write to device * @param length length (in number of bytes) of buffer @@ -98,6 +100,7 @@ extern ErrorStatus IODevice_write(const struct IODevice* self, const char* buffe * IODevice_read * Reads from IO Device * + * @memberof IODevice * @param self IO Device instance to create * @param buffer Pointer to location where read data is * written to diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Interlock.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Interlock.h index d68cf0e..b145c70 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Interlock.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Interlock.h @@ -85,6 +85,7 @@ struct Interlock * Constructor for an Interlock * Also creates and starts a FreeRTOS task for IO debouncing * + * @memberof Interlock * @param self The object to create * @param NO * @param NOEXTI @@ -103,6 +104,7 @@ extern ErrorStatus Interlock_construct(struct Interlock* self, T_INTERLOCK_ID ID * Interlock_getStatus * Get the current status of the interlock * + * @memberof Interlock * @param self Interlock object * @param command Interrupt status * @param NO value on GPIO NO @@ -120,6 +122,7 @@ extern void Interlock_getStatus(struct Interlock* self, FunctionalState* command * Interlock_isClosed * Check for interlock closed. Scans both I/Os * + * @memberof Interlock * @param self The interlock object * * @return bool TRUE is NC=1 and NO=0 @@ -134,6 +137,7 @@ extern bool Interlock_isClosed(struct Interlock* self); * Interlock_setEXTI * Description of function * + * @memberof Interlock * @param self * @param command * diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/KeyboardDevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/KeyboardDevice.h index 56df3d6..1c359ab 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/KeyboardDevice.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/KeyboardDevice.h @@ -71,8 +71,14 @@ struct KeyboardDevice // Function declarations // ----------------------------------------------------------------------------- +/** + * \memberof KeyboardDevice + */ extern ErrorStatus KeyboardDevice_construct (struct KeyboardDevice* self, struct KeyboardDeviceParameters* parameters, KeyboardReadFunction read); +/** + * \memberof KeyboardDevice + */ extern ErrorStatus KeyboardDevice_read(const struct KeyboardDevice* self, char* buffer, Keypad_KeyState* keyState); #endif /* INC_KEYBOARDDEVICE_H_ */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Logger.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Logger.h index 8fabb34..7622a55 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Logger.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Logger.h @@ -51,34 +51,69 @@ * Logs an error * \memberof Logger */ - #define LOGGER_ERROR(a, ...) \ Logger_log(a, __FILE__, __func__, __LINE__, LOGTYPE_ERROR, ##__VA_ARGS__) +/** + * Logs an error + * \memberof Logger + */ #define LOGGER_WARNING(a, ...) \ Logger_log(a, __FILE__, __func__, __LINE__, LOGTYPE_WARNING, ##__VA_ARGS__) +/** + * Logs an error + * \memberof Logger + */ #define LOGGER_INFO(a, ...) \ Logger_log(a, __FILE__, __func__, __LINE__, LOGTYPE_INFO, ##__VA_ARGS__) +/** + * Logs an error + * \memberof Logger + */ #define LOGGER_DEBUG(a, ...) \ Logger_log(a, __FILE__, __func__, __LINE__, LOGTYPE_DEBUG, ##__VA_ARGS__) +/** + * Logs an error + * \memberof Logger + */ #define LOGGER_PRINT(a, ...) \ Logger_log(a, "", "", 0, LOGTYPE_PRINT, ##__VA_ARGS__) +/** + * Logs an error + * \memberof Logger + */ #define LOGGER_ERROR_ISR(a, ...) \ Logger_logISR(a, __FILE__, __func__, __LINE__, LOGTYPE_ERROR, ##__VA_ARGS__) +/** + * Logs an error + * \memberof Logger + */ #define LOGGER_WARNING_ISR(a, ...) \ Logger_logISR(a, __FILE__, __func__, __LINE__, LOGTYPE_WARNING, ##__VA_ARGS__) +/** + * Logs an error + * \memberof Logger + */ #define LOGGER_INFO_ISR(a, ...) \ Logger_logISR(a, __FILE__, __func__, __LINE__, LOGTYPE_INFO, ##__VA_ARGS__) +/** + * Logs an error + * \memberof Logger + */ #define LOGGER_DEBUG_ISR(a, ...) \ Logger_logISR(a, __FILE__, __func__, __LINE__, LOGTYPE_DEBUG, ##__VA_ARGS__) +/** + * Logs an error + * \memberof Logger + */ #define LOGGER_PRINT_ISR(a, ...) \ Logger_logISR(a, "", "", 0, LOGTYPE_PRINT, ##__VA_ARGS__) diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MAX5715.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MAX5715.h index a3366df..78e1e6a 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MAX5715.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MAX5715.h @@ -148,6 +148,7 @@ struct MAX5715 * MAX5715_construct * Constructs the MAX5715 instance into argument self. * + * @memberof MAX5715 * @param self The MAX5715 object to initialize * @param device The IODevice that should be used for * communication with the MAX5715 @@ -165,6 +166,7 @@ extern ErrorStatus MAX5715_construct(struct MAX5715* self, const struct IODevice * MAX5715_destruct * Destructs the MAX5715 instance in argument self * + * @memberof MAX5715 * @param self * * @return ErrorStatus SUCCESS if destruction was successful @@ -196,6 +198,7 @@ extern ErrorStatus MAX5715_getSpiParameters(struct SpiParameters* parameters); * Sends a command to MAX5715 instance in argument self with the command in * argument command * + * @memberof MAX5715 * @param self The MAX5715 instance * @param command The command to be sent * @@ -212,6 +215,7 @@ extern ErrorStatus MAX5715_sendCommand(const struct MAX5715* self, uint8_t comma * MAX5715Channel_construct * Constructor for one of the channels on the MAX5715 DAC * + * @memberof MAX5715 * @param self The channel object to initialize * @param parent The parent object that the channel belongs * to @@ -230,6 +234,7 @@ extern ErrorStatus MAX5715Channel_construct(struct MAX5715_DAC* self, struct MAX * MAX5715Channel_setValue * Sends value to the DAC channel in self * + * @memberof MAX5715 * @param self The DAC object * @param value Value to write * diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MemoryDevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MemoryDevice.h index c5d7305..8a129ba 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MemoryDevice.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MemoryDevice.h @@ -74,6 +74,7 @@ struct MemoryDevice * MemoryDevice_construct * Description of function * + * @memberof MemoryDevice * @param self * @param startAddress * @return ErrorStatus @@ -88,6 +89,7 @@ extern ErrorStatus MemoryDevice_construct(struct MemoryDevice* self, uint32_t st * MemoryDevice_destruct * Description of function * + * @memberof MemoryDevice * @param self * @param * @return void @@ -102,6 +104,7 @@ extern void MemoryDevice_destruct(struct MemoryDevice* self); * MemoryDevice_read * Description of function * + * @memberof MemoryDevice * @param self * @param buffer * @param address @@ -119,6 +122,7 @@ extern ErrorStatus MemoryDevice_write(const struct MemoryDevice* self, uint32_t* * MemoryDevice_read * Description of function * + * @memberof MemoryDevice * @param self * @param buffer * @param address @@ -136,6 +140,7 @@ extern ErrorStatus MemoryDevice_read(const struct MemoryDevice* self, uint32_t* * MemoryDevice_erasePage * Description of function * + * @memberof MemoryDevice * @param self * @param page * @return ErrorStatus diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observable.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observable.h index 70b19ff..614fb01 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observable.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observable.h @@ -74,6 +74,7 @@ struct Observable /** * Initializes the Observable class. * This is not needed if the Observable has been statically initialized by "struct Observable observable = OBSERVABLE_INITIALIZER". +* @memberof Observable * @param self: address of the Observable struct. * @retval none. */ @@ -81,6 +82,7 @@ void Observable_construct(struct Observable* self); /** * Terminates the Observable class. All Observers are removed. +* @memberof Observable * @param self: address of the Observable struct. * @retval none. */ @@ -88,6 +90,7 @@ void Observable_destruct(struct Observable* self); /** * Adds one Observer to the Observable. +* @memberof Observable * @param self: address of the Observable struct. * @param observer: Observer to be added. * @retval ErrorStatus: returns an error in case the maximum number of Observers have been added. @@ -97,6 +100,7 @@ ErrorStatus Observable_addObserver(struct Observable* self, const Observer obser /** * Adds one Observer to the Observable at the front of the list. * This ensures that this Observer is notified before Observers added by Observable_addObserver. +* @memberof Observable * @param self: address of the Observable struct. * @param observer: Observer to be added. * @retval ErrorStatus: returns an error in case the maximum number of Observers have been added. @@ -106,6 +110,7 @@ ErrorStatus Observable_addObserverAtFront(struct Observable* self, const Observe /** * Notifies all Observers by calling the Observer callback function. The parameter void* data will be * passed as parameter to the Observer. +* @memberof Observable * @param self: address of the Observable struct. * @param data: void pointer data to be passed as parameter to the Observer. * @retval ErrorStatus: returns an error in case one or more of the Observers returned an error. @@ -114,6 +119,7 @@ ErrorStatus Observable_notifyObservers(const struct Observable* self, const void /** * Deletes one specific Observer added before. If the Observer cannot be found, no action is taken. +* @memberof Observable * @param self: address of the Observable struct. * @param observer: Observer to be deleted. */ @@ -121,12 +127,14 @@ void Observable_deleteObserver(struct Observable* self, const Observer observer) /** * Deletes all Observers added. +* @memberof Observable * @param self: address of the Observable struct. */ void Observable_deleteObservers(struct Observable* self); /** * Returns the number of Observers currently subscribed to an Observable. +* @memberof Observable * @param self: address of the Observable struct. */ int Observable_nrOfObservers(struct Observable* self); diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/PID.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/PID.h index 7770f88..a477c05 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/PID.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/PID.h @@ -66,6 +66,7 @@ struct Pid * PID_construct * Constructor for a PID regulator * + * @memberof Pid * @param self PID object to construct * @param Kp proportional constant * @param Ki integration constant @@ -86,6 +87,7 @@ extern ErrorStatus PID_construct(struct Pid* self, int Kp, int Ki, int Kd, int i * PID_destruct * Destructor for a PID regulator * + * @memberof Pid * @param self PID object to destruct * * @return void @@ -100,6 +102,7 @@ extern void PID_destruct(struct Pid* self); * PID_reset * Resets the pid regulator and cleans all history * + * @memberof Pid * @param self PID object to reset * * @return void @@ -114,6 +117,7 @@ extern void PID_reset(struct Pid* self); * PID_calculate * Calculate * + * @memberof Pid * @param self The PID object * @param input The input * @param error the error input to calculate diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/nhd0420.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/nhd0420.h index 71da1aa..c6817c1 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/nhd0420.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/nhd0420.h @@ -138,6 +138,7 @@ struct NHD0420 * NHD0420_construct * Initialises the NewHeaven Display 0420 * + * @memberof NHD0420 * @param interface The interface to use * * @return ErrorStatus SUCCESS if initialisation was successful @@ -153,6 +154,7 @@ extern ErrorStatus NHD0420_construct(struct NHD0420* self, const struct IODevice * NHD0420_destruct * Destructor for the NHD0420 instance * + * @memberof NHD0420 * @param interface The object to destruct * * @return void @@ -181,6 +183,7 @@ extern ErrorStatus NHD0420_getSpiParameters(struct SpiParameters* parameters); * NHD0420_setCursorToPosition * Sets the cursor of the display to the specified row and column * + * @memberof NHD0420 * @param row The Row to set - between 1 and 4 * @param column The column to set - between 1 and 20 * @@ -197,6 +200,7 @@ extern ErrorStatus NHD0420_setCursorToPosition(const struct NHD0420* self, unsig * NHD0420_setContrast * Sets the contrast of the display * + * @memberof NHD0420 * @param contrast The contrast to set - between 1 and 50. * If passed value is outside the boundaries * this function will return ERROR @@ -214,6 +218,7 @@ extern ErrorStatus NHD0420_setContrast(const struct NHD0420* self, char contrast * NHD0420_setBacklightBrightness * Sets the backlight brightness of the display * + * @memberof NHD0420 * @param brightness The contrast to set - between 1 and 8 * If passed value is outside the boundaries * this function will return ERROR @@ -231,6 +236,7 @@ extern ErrorStatus NHD0420_setBacklightBrightness(const struct NHD0420* self, ch * NHD0420_setRS232Baudrate * Sets the baudrate of the display * + * @memberof NHD0420 * @param baudrate The baudrate to set - between 1 and 8 * 1 = 300 baud * 2 = 1200 baud @@ -256,6 +262,7 @@ extern ErrorStatus NHD0420_setRS232Baudrate(const struct NHD0420* self, char bau * NHD0420_setI2CAddress * Sets the I2C address of the display * + * @memberof NHD0420 * @param address The address to set * This command sets the I2C address. The * address must be an even number (LSB = 0) @@ -281,6 +288,7 @@ extern ErrorStatus NHD0420_setI2CAddress(const struct NHD0420* self, char addres * NHD0420_SendCommand * Send a command to the display * + * @memberof NHD0420 * @param command * * @return ErrorStatus SUCCESS if initialisation was successful @@ -291,6 +299,17 @@ extern ErrorStatus NHD0420_setI2CAddress(const struct NHD0420* self, char addres */ extern ErrorStatus NHD0420_sendCommand(const struct NHD0420* self, char command); +/** ---------------------------------------------------------------------------- + * NHD0420_sendData + * + * @memberof NHD0420 + * + * @return ErrorStatus SUCCESS if initialisation was successful + * ERROR otherwise + * + * @todo + * ----------------------------------------------------------------------------- + */ extern ErrorStatus NHD0420_sendData(const struct NHD0420* self, const char* buffer, unsigned int length); #endif /* DISPLAY_INC_NHD0420_H_ */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/storm700.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/storm700.h index c61f66c..b581d2b 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/storm700.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/storm700.h @@ -68,6 +68,7 @@ struct Storm700 * Storm700_construct * Constructor for Storm700 keypad * + * @memberof Storm700 * @param self Keypad object to construct * @param device The IO device that is used to communicate * @@ -84,6 +85,7 @@ extern ErrorStatus Storm700_construct(struct Storm700* self, const struct IODevi * Storm700_destruct * Destructor for the Storm700 instance * + * @memberof Storm700 * @param self The object to destruct * * @return void @@ -98,6 +100,7 @@ extern void Storm700_destruct(struct Storm700* self); * Storm700_readKey * Read a key from the storm700 keypad * + * @memberof Storm700 * @param self Keypad instance * @param key The key that has been read. Will be * formatted ins ASCII code