From 2c0f82a4f07fe35bc043f68b9f58b954a16ea689 Mon Sep 17 00:00:00 2001 From: Amir Hammad Date: Fri, 8 Jul 2016 23:21:37 +0200 Subject: documentation: add some basic documentation accross the headers Signed-off-by: Amir Hammad --- include/usbh_driver_ac_midi.h | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'include/usbh_driver_ac_midi.h') diff --git a/include/usbh_driver_ac_midi.h b/include/usbh_driver_ac_midi.h index 7b006a9..0993589 100644 --- a/include/usbh_driver_ac_midi.h +++ b/include/usbh_driver_ac_midi.h @@ -36,9 +36,24 @@ struct _midi_config { }; typedef struct _midi_config midi_config_t; -typedef void (*midi_write_callback_t)(uint8_t); +/** + * @param bytes_written count of bytes that were actually written + */ +typedef void (*midi_write_callback_t)(uint8_t bytes_written); +/** + * @brief midi_driver_init initialization routine - this will initialize internal structures of this device driver + * @param config + */ void midi_driver_init(const midi_config_t *config); + +/** + * @brief usbh_midi_write + * @param device_id + * @param data + * @param length + * @param callback this is called when the write call finishes + */ void usbh_midi_write(uint8_t device_id, const void *data, uint32_t length, midi_write_callback_t callback); extern const usbh_dev_driver_t usbh_midi_driver; -- cgit