mirror of
				https://github.com/mfulz/qmk_firmware.git
				synced 2025-10-30 21:02:32 +01:00 
			
		
		
		
	Minor documentation improvements.
This commit is contained in:
		
							parent
							
								
									f2d7f6f674
								
							
						
					
					
						commit
						25224aae7e
					
				| @ -6,7 +6,7 @@ | |||||||
| 
 | 
 | ||||||
| /** \page Page_BuildLibrary Building as a Linkable Library | /** \page Page_BuildLibrary Building as a Linkable Library | ||||||
|  * |  * | ||||||
|  *  The LUFA library can be built as a proper linkable library (with the extention .a) under AVR-GCC, so that |  *  The LUFA library can be built as a proper linkable library (with the extension .a) under AVR-GCC, so that | ||||||
|  *  the library does not need to be recompiled with each revision of a user project. Instructions for creating |  *  the library does not need to be recompiled with each revision of a user project. Instructions for creating | ||||||
|  *  a library from a given source tree can be found in the AVR-GCC user manual included in the WinAVR install |  *  a library from a given source tree can be found in the AVR-GCC user manual included in the WinAVR install | ||||||
|  *  /Docs/ directory. |  *  /Docs/ directory. | ||||||
|  | |||||||
| @ -18,7 +18,7 @@ | |||||||
|  *  \section Sec_LibraryExport Exporting the Library |  *  \section Sec_LibraryExport Exporting the Library | ||||||
|  *  An export of the library is at its most basic, a direct copy of the main "LUFA" source folder from the |  *  An export of the library is at its most basic, a direct copy of the main "LUFA" source folder from the | ||||||
|  *  root download folder; this contains the library core which can be re-used within external projects. |  *  root download folder; this contains the library core which can be re-used within external projects. | ||||||
|  *  However, as many IDEs attempt to automatically compile all included source files, it is neccesary to |  *  However, as many IDEs attempt to automatically compile all included source files, it is necessary to | ||||||
|  *  exclude some directories and files from the library core export to allow for easier integration into |  *  exclude some directories and files from the library core export to allow for easier integration into | ||||||
|  *  an IDE project. |  *  an IDE project. | ||||||
|  * |  * | ||||||
|  | |||||||
| @ -9,9 +9,9 @@ | |||||||
|  * |  * | ||||||
|  *  The LUFA library is currently released under the MIT license, included below. |  *  The LUFA library is currently released under the MIT license, included below. | ||||||
|  * |  * | ||||||
|  *  \section Sec_LicenseForHumans License Sumary for Human Beings |  *  \section Sec_LicenseForHumans License Summary for Human Beings | ||||||
|  *  Everyone is free to use LUFA without payment - even in commercial applications |  *  Everyone is free to use LUFA without payment - even in commercial applications | ||||||
|  *  where the product source code is not publically disclosed. However, use of the |  *  where the product source code is not publicly disclosed. However, use of the | ||||||
|  *  library must be in accordance with the library license conditions. |  *  library must be in accordance with the library license conditions. | ||||||
|  * |  * | ||||||
|  *  If you wish to use LUFA without payment, you <b>must</b> include a copy of the |  *  If you wish to use LUFA without payment, you <b>must</b> include a copy of the | ||||||
| @ -23,7 +23,7 @@ | |||||||
|  * |  * | ||||||
|  *  \section Sec_CommercialLicenses Commercial Licensing |  *  \section Sec_CommercialLicenses Commercial Licensing | ||||||
|  *  In some instances the small requirement for public disclosure of LUFA within a |  *  In some instances the small requirement for public disclosure of LUFA within a | ||||||
|  *  product is unwanted; in these instances a commecial license is offered up as an |  *  product is unwanted; in these instances a commercial license is offered up as an | ||||||
|  *  alternative to the standard LUFA license. |  *  alternative to the standard LUFA license. | ||||||
|  * |  * | ||||||
|  *  Commercial entities can opt out of the public disclosure clause in this license |  *  Commercial entities can opt out of the public disclosure clause in this license | ||||||
|  | |||||||
| @ -43,8 +43,8 @@ | |||||||
|  *      to update their class driver struct instantiation to match the new scheme (see \ref USB_Endpoint_Table_t). |  *      to update their class driver struct instantiation to match the new scheme (see \ref USB_Endpoint_Table_t). | ||||||
|  *    - The \c ENDPOINT_BANKS_SUPPORTED() and \c ENDPOINT_MAX_ENDPOINT_SIZE() macros have been removed, as these do not function correctly with the new addressing |  *    - The \c ENDPOINT_BANKS_SUPPORTED() and \c ENDPOINT_MAX_ENDPOINT_SIZE() macros have been removed, as these do not function correctly with the new addressing | ||||||
|  *      scheme for the endpoint APIs. Please refer to the target device's datasheet for the maximum bank size of each endpoint. |  *      scheme for the endpoint APIs. Please refer to the target device's datasheet for the maximum bank size of each endpoint. | ||||||
|  *    - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains seperate \c CableIndex and \c Command entries; these have been combined |  *    - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains separate \c CableIndex and \c Command entries; these have been combined | ||||||
|  *      into a single \c Event element which can be contructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure |  *      into a single \c Event element which can be constructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure | ||||||
|  *      element name. |  *      element name. | ||||||
|  * |  * | ||||||
|  *  <b>Host Mode</b> |  *  <b>Host Mode</b> | ||||||
| @ -58,7 +58,7 @@ | |||||||
|  *    - All host mode class drivers have been updated to use a new unified pipe description structure for all pipes; existing applications will need to update |  *    - All host mode class drivers have been updated to use a new unified pipe description structure for all pipes; existing applications will need to update | ||||||
|  *      their class driver struct instantiation to match the new scheme (see \ref USB_Pipe_Table_t). |  *      their class driver struct instantiation to match the new scheme (see \ref USB_Pipe_Table_t). | ||||||
|  *    - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains seperate \c CableIndex and \c Command entries; these have been combined |  *    - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains seperate \c CableIndex and \c Command entries; these have been combined | ||||||
|  *      into a single \c Event element which can be contructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure |  *      into a single \c Event element which can be constructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure | ||||||
|  *      element name. |  *      element name. | ||||||
|  *    - The library "LUFA/Drivers/USB/Core/ConfigDescriptor.c" source file has been renamed "LUFA/Drivers/USB/Core/ConfigDescriptors.c" as this was clashing with |  *    - The library "LUFA/Drivers/USB/Core/ConfigDescriptor.c" source file has been renamed "LUFA/Drivers/USB/Core/ConfigDescriptors.c" as this was clashing with | ||||||
|  *      files in some low level host mode demo applications, preventing parallel project builds. If you are referencing the project source files directly instead |  *      files in some low level host mode demo applications, preventing parallel project builds. If you are referencing the project source files directly instead | ||||||
| @ -144,7 +144,7 @@ | |||||||
|  *      these functions should replace the previous function names with the new function names. |  *      these functions should replace the previous function names with the new function names. | ||||||
|  *    - The \c Pipe_*_DWord() functions have been renamed Pipe_*_32() to ensure they are correct across all architectures. Existing code using |  *    - The \c Pipe_*_DWord() functions have been renamed Pipe_*_32() to ensure they are correct across all architectures. Existing code using | ||||||
|  *      these functions should replace the previous function names with the new function names. |  *      these functions should replace the previous function names with the new function names. | ||||||
|  *    - The \c USB_Host_ClearPipeStall() function has been renamed to USB_Host_ClearEndpointStall(), as it operates on a full endpoing address |  *    - The \c USB_Host_ClearPipeStall() function has been renamed to USB_Host_ClearEndpointStall(), as it operates on a full endpoint address | ||||||
|  *      within the attached device and not a pipe within the host. Existing code using the old function name should update the function calls and |  *      within the attached device and not a pipe within the host. Existing code using the old function name should update the function calls and | ||||||
|  *      check for correct usage. |  *      check for correct usage. | ||||||
|  * |  * | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user
	 Dean Camera
						Dean Camera