From c75f8bf2236bc69511d0ff0bc79bfaf1f62e3bfd Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Mon, 15 Jun 2009 08:36:12 +0000 Subject: More Doxygen fixes - ensure no undocumented function parameters. --- Demos/Device/ClassDriver/AudioInput/Doxygen.conf | 2 +- Demos/Device/ClassDriver/AudioOutput/Doxygen.conf | 2 +- Demos/Device/ClassDriver/CDC/Doxygen.conf | 2 +- Demos/Device/ClassDriver/DualCDC/Doxygen.conf | 2 +- Demos/Device/ClassDriver/GenericHID/Doxygen.conf | 2 +- Demos/Device/ClassDriver/Joystick/Doxygen.conf | 2 +- Demos/Device/ClassDriver/Keyboard/Doxygen.conf | 2 +- Demos/Device/ClassDriver/KeyboardMouse/Doxygen.conf | 2 +- Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c | 1 + Demos/Device/ClassDriver/MIDI/Doxygen.conf | 2 +- Demos/Device/ClassDriver/MassStorage/Doxygen.conf | 2 +- Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c | 2 ++ Demos/Device/ClassDriver/Mouse/Doxygen.conf | 2 +- Demos/Device/ClassDriver/RNDISEthernet/Doxygen.conf | 2 +- Demos/Device/ClassDriver/USBtoSerial/Doxygen.conf | 2 +- 15 files changed, 16 insertions(+), 13 deletions(-) (limited to 'Demos/Device/ClassDriver') 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 -- cgit v1.2.3