forked from mfulz_github/qmk_firmware
		
	Add known issues to the documentation.
This commit is contained in:
		
							parent
							
								
									1ab76048c9
								
							
						
					
					
						commit
						c48da94605
					
				
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -26,7 +26,6 @@
 | 
				
			|||||||
  *      -# Make HOST_DEVICE_SETTLE_DELAY_MS a global variable that can be changed
 | 
					  *      -# Make HOST_DEVICE_SETTLE_DELAY_MS a global variable that can be changed
 | 
				
			||||||
  *      -# Add MANDATORY_EVENT_FUNCTIONS compile time option
 | 
					  *      -# Add MANDATORY_EVENT_FUNCTIONS compile time option
 | 
				
			||||||
  *      -# Add watchdog support to the library and apps/bootloaders
 | 
					  *      -# Add watchdog support to the library and apps/bootloaders
 | 
				
			||||||
  *      -# Fix Still Image Host class driver - missing reqs, parameters
 | 
					 | 
				
			||||||
  *  - Testing/Verification
 | 
					  *  - Testing/Verification
 | 
				
			||||||
  *      -# Re-run USBIF test suite on all classes to formally verify operation
 | 
					  *      -# Re-run USBIF test suite on all classes to formally verify operation
 | 
				
			||||||
  *      -# Implement automated functional testing of all demos
 | 
					  *      -# Implement automated functional testing of all demos
 | 
				
			||||||
 | 
				
			|||||||
							
								
								
									
										38
									
								
								LUFA/DoxygenPages/KnownIssues.txt
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										38
									
								
								LUFA/DoxygenPages/KnownIssues.txt
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,38 @@
 | 
				
			|||||||
 | 
					/** \file
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 *  This file contains special DoxyGen information for the generation of the main page and other special
 | 
				
			||||||
 | 
					 *  documentation pages. It is not a project source file.
 | 
				
			||||||
 | 
					 */
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					 /** \page Page_KnownIssues Known Issues
 | 
				
			||||||
 | 
					  *  The following are known issues present in each official LUFA release. This list should contain all known
 | 
				
			||||||
 | 
					  *  issues in the library. Most of these issues should be corrected in the future release - see
 | 
				
			||||||
 | 
					  *  \ref Page_FutureChanges for a list of planned changes in future releases.
 | 
				
			||||||
 | 
					  *
 | 
				
			||||||
 | 
					  *  \section Sec_KnownIssuesXXXXXX Version XXXXXX
 | 
				
			||||||
 | 
					  *  - AVR8 Architecture
 | 
				
			||||||
 | 
					  *    - No known issues.
 | 
				
			||||||
 | 
					  *  - XMEGA Architecture
 | 
				
			||||||
 | 
					  *    - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release,
 | 
				
			||||||
 | 
					  *      although the architecture is supported in the LUFA core library.
 | 
				
			||||||
 | 
					  *    - Endpoints of more than 64 bytes are not currently supported in this release.
 | 
				
			||||||
 | 
					  *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
 | 
				
			||||||
 | 
					  *      cannot be used on XMEGA devices.
 | 
				
			||||||
 | 
					  *    - Multiple-bank endpoints are not currently supported in this release.
 | 
				
			||||||
 | 
					  *    - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
 | 
				
			||||||
 | 
					  *      relating to the USB controller.
 | 
				
			||||||
 | 
					  *  - UC3 Architecture
 | 
				
			||||||
 | 
					  *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
 | 
				
			||||||
 | 
					  *      although the architecture is supported in the LUFA core library.
 | 
				
			||||||
 | 
					  *    - DMA transfers to and from the USB controller are not yet implemented for this release.
 | 
				
			||||||
 | 
					  *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
 | 
				
			||||||
 | 
					  *      altered USB controller design.
 | 
				
			||||||
 | 
					  *  - Architecture Independant
 | 
				
			||||||
 | 
					  *    - The HID parser fails for array type elements that have a MIN and MAX usage applied; each element
 | 
				
			||||||
 | 
					  *      in the array will receive a unique incrementing usage from the MIN value, up to MAX.
 | 
				
			||||||
 | 
					  *    - The current application makefiles do not work if the output directory is not the same directory
 | 
				
			||||||
 | 
					  *      as the makefile itself.
 | 
				
			||||||
 | 
					  *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
 | 
				
			||||||
 | 
					  *      and a lengthy USB operation is initiated.
 | 
				
			||||||
 | 
					  */
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -42,6 +42,7 @@
 | 
				
			|||||||
 *  \li \subpage Page_Donating - Donating to support this project
 | 
					 *  \li \subpage Page_Donating - Donating to support this project
 | 
				
			||||||
 *  \li \subpage Page_DeviceSupport - Current Device and Hardware Support
 | 
					 *  \li \subpage Page_DeviceSupport - Current Device and Hardware Support
 | 
				
			||||||
 *  \li \subpage Page_ChangeLog - Project Changelog
 | 
					 *  \li \subpage Page_ChangeLog - Project Changelog
 | 
				
			||||||
 | 
					 *  \li \subpage Page_KnownIssues - Known Issues
 | 
				
			||||||
 *  \li \subpage Page_FutureChanges - Planned Changes to the Library
 | 
					 *  \li \subpage Page_FutureChanges - Planned Changes to the Library
 | 
				
			||||||
 *  \li \subpage Page_GettingStarted - Getting started with LUFA
 | 
					 *  \li \subpage Page_GettingStarted - Getting started with LUFA
 | 
				
			||||||
 *  \li \subpage Page_DevelopingWithLUFA - Developing with LUFA
 | 
					 *  \li \subpage Page_DevelopingWithLUFA - Developing with LUFA
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user