From c75f8bf2236bc69511d0ff0bc79bfaf1f62e3bfd Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Mon, 15 Jun 2009 08:36:12 +0000 Subject: [PATCH] More Doxygen fixes - ensure no undocumented function parameters. --- Bootloaders/CDC/Doxygen.conf | 2 +- Bootloaders/DFU/Doxygen.conf | 2 +- Bootloaders/TeensyHID/Doxygen.conf | 2 +- .../ClassDriver/AudioInput/Doxygen.conf | 2 +- .../ClassDriver/AudioOutput/Doxygen.conf | 2 +- Demos/Device/ClassDriver/CDC/Doxygen.conf | 2 +- Demos/Device/ClassDriver/DualCDC/Doxygen.conf | 2 +- .../ClassDriver/GenericHID/Doxygen.conf | 2 +- .../Device/ClassDriver/Joystick/Doxygen.conf | 2 +- .../Device/ClassDriver/Keyboard/Doxygen.conf | 2 +- .../ClassDriver/KeyboardMouse/Doxygen.conf | 2 +- .../ClassDriver/KeyboardMouse/KeyboardMouse.c | 1 + Demos/Device/ClassDriver/MIDI/Doxygen.conf | 2 +- .../ClassDriver/MassStorage/Doxygen.conf | 2 +- .../MassStorage/Lib/DataflashManager.c | 2 ++ Demos/Device/ClassDriver/Mouse/Doxygen.conf | 2 +- .../ClassDriver/RNDISEthernet/Doxygen.conf | 2 +- .../ClassDriver/USBtoSerial/Doxygen.conf | 2 +- Demos/Device/LowLevel/AudioInput/Doxygen.conf | 2 +- .../Device/LowLevel/AudioOutput/Doxygen.conf | 2 +- Demos/Device/LowLevel/CDC/Doxygen.conf | 2 +- Demos/Device/LowLevel/DualCDC/Doxygen.conf | 2 +- Demos/Device/LowLevel/GenericHID/Doxygen.conf | 2 +- Demos/Device/LowLevel/Joystick/Doxygen.conf | 2 +- Demos/Device/LowLevel/Keyboard/Doxygen.conf | 2 +- .../LowLevel/KeyboardMouse/Doxygen.conf | 2 +- Demos/Device/LowLevel/MIDI/Doxygen.conf | 2 +- .../Device/LowLevel/MassStorage/Doxygen.conf | 2 +- Demos/Device/LowLevel/Mouse/Doxygen.conf | 2 +- .../LowLevel/RNDISEthernet/Doxygen.conf | 2 +- .../Device/LowLevel/USBtoSerial/Doxygen.conf | 2 +- Demos/Host/ClassDriver/CDCHost/Doxygen.conf | 2 +- .../ClassDriver/GenericHIDHost/Doxygen.conf | 2 +- .../ClassDriver/KeyboardHost/Doxygen.conf | 2 +- .../KeyboardHostWithParser/Doxygen.conf | 2 +- .../ClassDriver/MassStorageHost/Doxygen.conf | 2 +- Demos/Host/ClassDriver/MouseHost/Doxygen.conf | 2 +- .../MouseHostWithParser/Doxygen.conf | 2 +- .../ClassDriver/StillImageHost/Doxygen.conf | 2 +- Demos/Host/LowLevel/CDCHost/Doxygen.conf | 2 +- .../Host/LowLevel/GenericHIDHost/Doxygen.conf | 2 +- Demos/Host/LowLevel/KeyboardHost/Doxygen.conf | 2 +- .../KeyboardHostWithParser/Doxygen.conf | 2 +- .../LowLevel/MassStorageHost/Doxygen.conf | 2 +- Demos/Host/LowLevel/MouseHost/Doxygen.conf | 2 +- .../LowLevel/MouseHostWithParser/Doxygen.conf | 2 +- .../Host/LowLevel/StillImageHost/Doxygen.conf | 2 +- Demos/OTG/TestApp/Doxygen.conf | 2 +- LUFA/Doxygen.conf | 2 +- LUFA/Drivers/USB/Class/Host/CDC.h | 31 +++++++++++++++++++ LUFA/Drivers/USB/Class/Host/MassStorage.h | 2 +- LUFA/Drivers/USB/Class/Host/StillImage.h | 2 +- Projects/Magstripe/Doxygen.conf | 2 +- Projects/Magstripe/Magstripe.c | 2 ++ 54 files changed, 86 insertions(+), 50 deletions(-) diff --git a/Bootloaders/CDC/Doxygen.conf b/Bootloaders/CDC/Doxygen.conf index 5ba226d2f2..d0058653b7 100644 --- a/Bootloaders/CDC/Doxygen.conf +++ b/Bootloaders/CDC/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Bootloaders/DFU/Doxygen.conf b/Bootloaders/DFU/Doxygen.conf index f78e5fdefa..6a758f9453 100644 --- a/Bootloaders/DFU/Doxygen.conf +++ b/Bootloaders/DFU/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Bootloaders/TeensyHID/Doxygen.conf b/Bootloaders/TeensyHID/Doxygen.conf index 0df2320ac2..6353d8dd16 100644 --- a/Bootloaders/TeensyHID/Doxygen.conf +++ b/Bootloaders/TeensyHID/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/AudioInput/Doxygen.conf b/Demos/Device/ClassDriver/AudioInput/Doxygen.conf index f84efb7ba3..84e91fce7a 100644 --- a/Demos/Device/ClassDriver/AudioInput/Doxygen.conf +++ b/Demos/Device/ClassDriver/AudioInput/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/AudioOutput/Doxygen.conf b/Demos/Device/ClassDriver/AudioOutput/Doxygen.conf index 114137e199..b9d47463e0 100644 --- a/Demos/Device/ClassDriver/AudioOutput/Doxygen.conf +++ b/Demos/Device/ClassDriver/AudioOutput/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/CDC/Doxygen.conf b/Demos/Device/ClassDriver/CDC/Doxygen.conf index 3493347c50..40b3964443 100644 --- a/Demos/Device/ClassDriver/CDC/Doxygen.conf +++ b/Demos/Device/ClassDriver/CDC/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/DualCDC/Doxygen.conf b/Demos/Device/ClassDriver/DualCDC/Doxygen.conf index 7b3b741761..ebe36370b2 100644 --- a/Demos/Device/ClassDriver/DualCDC/Doxygen.conf +++ b/Demos/Device/ClassDriver/DualCDC/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/GenericHID/Doxygen.conf b/Demos/Device/ClassDriver/GenericHID/Doxygen.conf index dea5d4fce2..a1702c35f9 100644 --- a/Demos/Device/ClassDriver/GenericHID/Doxygen.conf +++ b/Demos/Device/ClassDriver/GenericHID/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/Joystick/Doxygen.conf b/Demos/Device/ClassDriver/Joystick/Doxygen.conf index 2af5ce68e4..c1645674db 100644 --- a/Demos/Device/ClassDriver/Joystick/Doxygen.conf +++ b/Demos/Device/ClassDriver/Joystick/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/Keyboard/Doxygen.conf b/Demos/Device/ClassDriver/Keyboard/Doxygen.conf index 79a300aed4..d30abd5b42 100644 --- a/Demos/Device/ClassDriver/Keyboard/Doxygen.conf +++ b/Demos/Device/ClassDriver/Keyboard/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/KeyboardMouse/Doxygen.conf b/Demos/Device/ClassDriver/KeyboardMouse/Doxygen.conf index 12916856b6..617aa9b3e2 100644 --- a/Demos/Device/ClassDriver/KeyboardMouse/Doxygen.conf +++ b/Demos/Device/ClassDriver/KeyboardMouse/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c index 1d94f1b267..30e90f4a99 100644 --- a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c +++ b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c @@ -213,6 +213,7 @@ uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceIn /** HID class driver callback function for the processing of HID reports from the host. * * \param HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced + * \param ReportID Report ID of the received report from the host * \param ReportData Pointer to a buffer where the created report has been stored * \param ReportSize Size in bytes of the received HID report */ diff --git a/Demos/Device/ClassDriver/MIDI/Doxygen.conf b/Demos/Device/ClassDriver/MIDI/Doxygen.conf index 7d36de8ed7..7e86bb96a9 100644 --- a/Demos/Device/ClassDriver/MIDI/Doxygen.conf +++ b/Demos/Device/ClassDriver/MIDI/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/MassStorage/Doxygen.conf b/Demos/Device/ClassDriver/MassStorage/Doxygen.conf index a7b9001606..854f9af13f 100644 --- a/Demos/Device/ClassDriver/MassStorage/Doxygen.conf +++ b/Demos/Device/ClassDriver/MassStorage/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c b/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c index 87edef12b4..4ec52c3451 100644 --- a/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c +++ b/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c @@ -43,6 +43,7 @@ * the pre-selected data OUT endpoint. This routine reads in OS sized blocks from the endpoint and writes * them to the dataflash in Dataflash page sized blocks. * + * \param MSInterfaceInfo Pointer to a Mass Storage class state structure for the Mass Storage interface being used * \param BlockAddress Data block starting address for the write sequence * \param TotalBlocks Number of blocks of data to write */ @@ -168,6 +169,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_t* MSInterfaceInfo, const uin * the pre-selected data IN endpoint. This routine reads in Dataflash page sized blocks from the Dataflash * and writes them in OS sized blocks to the endpoint. * + * \param MSInterfaceInfo Pointer to a Mass Storage class state structure for the Mass Storage interface being used * \param BlockAddress Data block starting address for the read sequence * \param TotalBlocks Number of blocks of data to read */ diff --git a/Demos/Device/ClassDriver/Mouse/Doxygen.conf b/Demos/Device/ClassDriver/Mouse/Doxygen.conf index 62c4db1106..ee8986f953 100644 --- a/Demos/Device/ClassDriver/Mouse/Doxygen.conf +++ b/Demos/Device/ClassDriver/Mouse/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Doxygen.conf b/Demos/Device/ClassDriver/RNDISEthernet/Doxygen.conf index 9d7973b789..0e2dfc2bd0 100644 --- a/Demos/Device/ClassDriver/RNDISEthernet/Doxygen.conf +++ b/Demos/Device/ClassDriver/RNDISEthernet/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/ClassDriver/USBtoSerial/Doxygen.conf b/Demos/Device/ClassDriver/USBtoSerial/Doxygen.conf index 1eb8c5432e..56129a1884 100644 --- a/Demos/Device/ClassDriver/USBtoSerial/Doxygen.conf +++ b/Demos/Device/ClassDriver/USBtoSerial/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/AudioInput/Doxygen.conf b/Demos/Device/LowLevel/AudioInput/Doxygen.conf index f84efb7ba3..84e91fce7a 100644 --- a/Demos/Device/LowLevel/AudioInput/Doxygen.conf +++ b/Demos/Device/LowLevel/AudioInput/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/AudioOutput/Doxygen.conf b/Demos/Device/LowLevel/AudioOutput/Doxygen.conf index 114137e199..b9d47463e0 100644 --- a/Demos/Device/LowLevel/AudioOutput/Doxygen.conf +++ b/Demos/Device/LowLevel/AudioOutput/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/CDC/Doxygen.conf b/Demos/Device/LowLevel/CDC/Doxygen.conf index 3493347c50..40b3964443 100644 --- a/Demos/Device/LowLevel/CDC/Doxygen.conf +++ b/Demos/Device/LowLevel/CDC/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/DualCDC/Doxygen.conf b/Demos/Device/LowLevel/DualCDC/Doxygen.conf index 7b3b741761..ebe36370b2 100644 --- a/Demos/Device/LowLevel/DualCDC/Doxygen.conf +++ b/Demos/Device/LowLevel/DualCDC/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/GenericHID/Doxygen.conf b/Demos/Device/LowLevel/GenericHID/Doxygen.conf index dea5d4fce2..a1702c35f9 100644 --- a/Demos/Device/LowLevel/GenericHID/Doxygen.conf +++ b/Demos/Device/LowLevel/GenericHID/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/Joystick/Doxygen.conf b/Demos/Device/LowLevel/Joystick/Doxygen.conf index 2af5ce68e4..c1645674db 100644 --- a/Demos/Device/LowLevel/Joystick/Doxygen.conf +++ b/Demos/Device/LowLevel/Joystick/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/Keyboard/Doxygen.conf b/Demos/Device/LowLevel/Keyboard/Doxygen.conf index 79a300aed4..d30abd5b42 100644 --- a/Demos/Device/LowLevel/Keyboard/Doxygen.conf +++ b/Demos/Device/LowLevel/Keyboard/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/KeyboardMouse/Doxygen.conf b/Demos/Device/LowLevel/KeyboardMouse/Doxygen.conf index 12916856b6..617aa9b3e2 100644 --- a/Demos/Device/LowLevel/KeyboardMouse/Doxygen.conf +++ b/Demos/Device/LowLevel/KeyboardMouse/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/MIDI/Doxygen.conf b/Demos/Device/LowLevel/MIDI/Doxygen.conf index 7d36de8ed7..7e86bb96a9 100644 --- a/Demos/Device/LowLevel/MIDI/Doxygen.conf +++ b/Demos/Device/LowLevel/MIDI/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/MassStorage/Doxygen.conf b/Demos/Device/LowLevel/MassStorage/Doxygen.conf index a7b9001606..854f9af13f 100644 --- a/Demos/Device/LowLevel/MassStorage/Doxygen.conf +++ b/Demos/Device/LowLevel/MassStorage/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/Mouse/Doxygen.conf b/Demos/Device/LowLevel/Mouse/Doxygen.conf index 62c4db1106..ee8986f953 100644 --- a/Demos/Device/LowLevel/Mouse/Doxygen.conf +++ b/Demos/Device/LowLevel/Mouse/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/RNDISEthernet/Doxygen.conf b/Demos/Device/LowLevel/RNDISEthernet/Doxygen.conf index 9d7973b789..0e2dfc2bd0 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Doxygen.conf +++ b/Demos/Device/LowLevel/RNDISEthernet/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Device/LowLevel/USBtoSerial/Doxygen.conf b/Demos/Device/LowLevel/USBtoSerial/Doxygen.conf index 1eb8c5432e..56129a1884 100644 --- a/Demos/Device/LowLevel/USBtoSerial/Doxygen.conf +++ b/Demos/Device/LowLevel/USBtoSerial/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/ClassDriver/CDCHost/Doxygen.conf b/Demos/Host/ClassDriver/CDCHost/Doxygen.conf index 320951a5fb..b290c01710 100644 --- a/Demos/Host/ClassDriver/CDCHost/Doxygen.conf +++ b/Demos/Host/ClassDriver/CDCHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/ClassDriver/GenericHIDHost/Doxygen.conf b/Demos/Host/ClassDriver/GenericHIDHost/Doxygen.conf index 0626a8a8aa..f5c1a11ff5 100644 --- a/Demos/Host/ClassDriver/GenericHIDHost/Doxygen.conf +++ b/Demos/Host/ClassDriver/GenericHIDHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/ClassDriver/KeyboardHost/Doxygen.conf b/Demos/Host/ClassDriver/KeyboardHost/Doxygen.conf index 3bdbc95ee5..4ad612e1ba 100644 --- a/Demos/Host/ClassDriver/KeyboardHost/Doxygen.conf +++ b/Demos/Host/ClassDriver/KeyboardHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/ClassDriver/KeyboardHostWithParser/Doxygen.conf b/Demos/Host/ClassDriver/KeyboardHostWithParser/Doxygen.conf index 6c6db18fae..cd4379f643 100644 --- a/Demos/Host/ClassDriver/KeyboardHostWithParser/Doxygen.conf +++ b/Demos/Host/ClassDriver/KeyboardHostWithParser/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/ClassDriver/MassStorageHost/Doxygen.conf b/Demos/Host/ClassDriver/MassStorageHost/Doxygen.conf index b154575bf3..16a065fc85 100644 --- a/Demos/Host/ClassDriver/MassStorageHost/Doxygen.conf +++ b/Demos/Host/ClassDriver/MassStorageHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/ClassDriver/MouseHost/Doxygen.conf b/Demos/Host/ClassDriver/MouseHost/Doxygen.conf index 5194af3753..01b211aaef 100644 --- a/Demos/Host/ClassDriver/MouseHost/Doxygen.conf +++ b/Demos/Host/ClassDriver/MouseHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/ClassDriver/MouseHostWithParser/Doxygen.conf b/Demos/Host/ClassDriver/MouseHostWithParser/Doxygen.conf index f3f45e313c..97d38f5126 100644 --- a/Demos/Host/ClassDriver/MouseHostWithParser/Doxygen.conf +++ b/Demos/Host/ClassDriver/MouseHostWithParser/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/ClassDriver/StillImageHost/Doxygen.conf b/Demos/Host/ClassDriver/StillImageHost/Doxygen.conf index d3a494a5f0..b35dfa767e 100644 --- a/Demos/Host/ClassDriver/StillImageHost/Doxygen.conf +++ b/Demos/Host/ClassDriver/StillImageHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/LowLevel/CDCHost/Doxygen.conf b/Demos/Host/LowLevel/CDCHost/Doxygen.conf index 320951a5fb..b290c01710 100644 --- a/Demos/Host/LowLevel/CDCHost/Doxygen.conf +++ b/Demos/Host/LowLevel/CDCHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/LowLevel/GenericHIDHost/Doxygen.conf b/Demos/Host/LowLevel/GenericHIDHost/Doxygen.conf index 0626a8a8aa..f5c1a11ff5 100644 --- a/Demos/Host/LowLevel/GenericHIDHost/Doxygen.conf +++ b/Demos/Host/LowLevel/GenericHIDHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/LowLevel/KeyboardHost/Doxygen.conf b/Demos/Host/LowLevel/KeyboardHost/Doxygen.conf index 3bdbc95ee5..4ad612e1ba 100644 --- a/Demos/Host/LowLevel/KeyboardHost/Doxygen.conf +++ b/Demos/Host/LowLevel/KeyboardHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/LowLevel/KeyboardHostWithParser/Doxygen.conf b/Demos/Host/LowLevel/KeyboardHostWithParser/Doxygen.conf index 6c6db18fae..cd4379f643 100644 --- a/Demos/Host/LowLevel/KeyboardHostWithParser/Doxygen.conf +++ b/Demos/Host/LowLevel/KeyboardHostWithParser/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/LowLevel/MassStorageHost/Doxygen.conf b/Demos/Host/LowLevel/MassStorageHost/Doxygen.conf index b154575bf3..16a065fc85 100644 --- a/Demos/Host/LowLevel/MassStorageHost/Doxygen.conf +++ b/Demos/Host/LowLevel/MassStorageHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/LowLevel/MouseHost/Doxygen.conf b/Demos/Host/LowLevel/MouseHost/Doxygen.conf index 5194af3753..01b211aaef 100644 --- a/Demos/Host/LowLevel/MouseHost/Doxygen.conf +++ b/Demos/Host/LowLevel/MouseHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/LowLevel/MouseHostWithParser/Doxygen.conf b/Demos/Host/LowLevel/MouseHostWithParser/Doxygen.conf index f3f45e313c..97d38f5126 100644 --- a/Demos/Host/LowLevel/MouseHostWithParser/Doxygen.conf +++ b/Demos/Host/LowLevel/MouseHostWithParser/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/Host/LowLevel/StillImageHost/Doxygen.conf b/Demos/Host/LowLevel/StillImageHost/Doxygen.conf index d3a494a5f0..b35dfa767e 100644 --- a/Demos/Host/LowLevel/StillImageHost/Doxygen.conf +++ b/Demos/Host/LowLevel/StillImageHost/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Demos/OTG/TestApp/Doxygen.conf b/Demos/OTG/TestApp/Doxygen.conf index 80e1b7e4a8..1f096bd9c9 100644 --- a/Demos/OTG/TestApp/Doxygen.conf +++ b/Demos/OTG/TestApp/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/LUFA/Doxygen.conf b/LUFA/Doxygen.conf index 3b94c4bac5..440031393d 100644 --- a/LUFA/Doxygen.conf +++ b/LUFA/Doxygen.conf @@ -592,7 +592,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index 292411be40..3bc814dafe 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -50,6 +50,37 @@ #endif /* Public Interface - May be used in end-application: */ + /* Type Defines: */ + typedef struct + { + bool IsActive; /**< Indicates if this class driver is currently attached to the device */ + + uint8_t ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */ + + uint8_t DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */ + uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */ + + uint8_t DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */ + uint16_t DataOUTPipeSize; /**< Size in bytes of the CDC interface's OUT data pipe */ + + uint8_t NotificationEndpointNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */ + uint16_t NotificationEndpointSize; /**< Size in bytes of the CDC interface's IN notification endpoint, if used */ + + uint8_t ControlLineState; /**< Current control line states */ + + struct + { + uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */ + uint8_t CharFormat; /**< Character format of the virtual serial port, a value from the + * CDCDevice_CDC_LineCodingFormats_t enum + */ + uint8_t ParityType; /**< Parity setting of the virtual serial port, a value from the + * CDCDevice_LineCodingParity_t enum + */ + uint8_t DataBits; /**< Bits of data per character of the virtual serial port */ + } LineEncoding; + } USB_ClassInfo_CDC_Host_t; + /* Function Prototypes: */ void CDC_Host_Task(void); diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h index e87a914371..edb494cc10 100644 --- a/LUFA/Drivers/USB/Class/Host/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h @@ -28,7 +28,7 @@ this software. */ -/** \ingroup Group_USBClassMassStorage +/** \ingroup Group_USBClassMS * @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver * * \section Module Description diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h index c83ad5bd5b..000b553b5e 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.h +++ b/LUFA/Drivers/USB/Class/Host/StillImage.h @@ -28,7 +28,7 @@ this software. */ -/** \ingroup Group_USBClassStillImage +/** \ingroup Group_USBClassSI * @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver * * \section Module Description diff --git a/Projects/Magstripe/Doxygen.conf b/Projects/Magstripe/Doxygen.conf index 4d0abf9b53..f5bfcf492b 100644 --- a/Projects/Magstripe/Doxygen.conf +++ b/Projects/Magstripe/Doxygen.conf @@ -593,7 +593,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = Documentation/ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/Projects/Magstripe/Magstripe.c b/Projects/Magstripe/Magstripe.c index 716b9953ce..4e26d9b225 100644 --- a/Projects/Magstripe/Magstripe.c +++ b/Projects/Magstripe/Magstripe.c @@ -153,6 +153,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK) /** HID Class driver callback function for the creation of a HID report for the host. * * \param HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced + * \param ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param ReportData Pointer to the preallocated report buffer where the created report should be stored * * \return Number of bytes in the created report @@ -201,6 +202,7 @@ uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_Device_t* HIDInt /** HID Class driver callback function for the processing of a received HID report from the host. * * \param HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced + * \param ReportID Report ID of the received report from the host * \param ReportData Pointer to the report buffer where the received report is stored * \param ReportSize Size in bytes of the report received from the host */