Added better module summaries.

15 years ago · 312748702a
parent e9215b4b36
commit 312748702a
16 changed files with 37 additions and 19 deletions
--- a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
+++ b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
@ -56,7 +56,7 @@
 *  as a USB microphone. Incoming audio from the ADC channel 1 will
 *  be sampled and sent to the host computer.
 *  
- *  To use, connect a microphone to the ADC channel 2.
+ *  To use, connect a microphone to the ADC channel 1.
 *  
 *  Under Windows, if a driver request dialogue pops up, select the option
 *  to automatically install the appropriate drivers.
--- a/LUFA/Doxygen.conf
+++ b/LUFA/Doxygen.conf
@ -1388,7 +1388,7 @@ INCLUDED_BY_GRAPH      = YES
 # the time of a run. So in most cases it will be better to enable call graphs 
 # for selected functions only using the \callgraph command.

-CALL_GRAPH             = YES
+CALL_GRAPH             = NO

 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
 # doxygen will generate a caller dependency graph for every global function 
--- a/LUFA/Drivers/Board/Buttons.h
+++ b/LUFA/Drivers/Board/Buttons.h
@ -48,7 +48,9 @@
 *    - None
 *
 *  \section Module Description
- *  Functions, macros, variables, enums and types related to the control of physical board GPIO buttons.
+ *  Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
+ *  It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
+ *  actions can be taken.
 *
 *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
 *  directory. Otherwise, it will include the appropriate built in board driver header file.
--- a/LUFA/Drivers/Board/Dataflash.h
+++ b/LUFA/Drivers/Board/Dataflash.h
@ -48,7 +48,8 @@
 *    - None
 *
 *  \section Module Description
- *  Functions, macros, variables, enums and types related to the control of board Dataflash ICs.
+ *  Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards,
+ *  for the storage of large amounts of data into the Dataflash's non-volatile memory.
 *
 *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
 *  directory. Otherwise, it will include the appropriate built in board driver header file.
--- a/LUFA/Drivers/Board/Joystick.h
+++ b/LUFA/Drivers/Board/Joystick.h
@ -48,7 +48,8 @@
 *    - None
 *
 *  \section Module Description
- *  Functions, macros, variables, enums and types related to the control of board joystick.
+ *  Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
+ *  located on many boards.
 *
 *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
 *  directory. Otherwise, it will include the appropriate built in board driver header file.
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@ -48,7 +48,8 @@
 *    - None
 *
 *  \section Module Description
- *  Functions, macros, variables, enums and types related to the control of board LEDs.
+ *  Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It
+ *  provides an interface to configure, test and change the status of all the board LEDs.
 *
 *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
 *  directory. Otherwise, it will include the appropriate built in board driver header file.
--- a/LUFA/Drivers/Board/Temperature.h
+++ b/LUFA/Drivers/Board/Temperature.h
@ -41,7 +41,10 @@
 *    - LUFA/Drivers/Board/Temperature.c
 *
 *  \section Module Description
- *  Functions, macros, variables, enums and types related to the control of board temperature sensors.
+ *  Temperature sensor driver. This provides an easy to use interface for the hardware temperature sensor located
+ *  on many boards. It provides an interface to configure the sensor and appropriate ADC channel, plus read out the
+ *  current temperature in degrees C. It is designed for and will only work with the temperature sensor located on the
+ *  official Atmel USB AVR boards, as each sensor has different characteristics.
 *
 *  @{
 */
--- a/LUFA/Drivers/Peripheral/ADC.h
+++ b/LUFA/Drivers/Peripheral/ADC.h
@ -44,7 +44,9 @@
 *    - None
 *
 *  \section Module Description
- *  Functions, macros, variables, enums and types related to the setup of a the ADC subsystem.
+ *  Hardware ADC driver. This module provides an easy to use driver for the hardware
+ *  ADC present on many AVR models, for the conversion of analogue signals into the
+ *  digital domain.
 */
 
 #ifndef __ADC_H__
--- a/LUFA/Drivers/Peripheral/SPI.h
+++ b/LUFA/Drivers/Peripheral/SPI.h
@ -41,7 +41,8 @@
 *    - None
 *
 *  \section Module Description
- *  Functions, macros, variables, enums and types related to the setup of a the SPI port.
+ *  Driver for the hardware SPI port avaliable on most AVR models. This module provides
+ *  an easy to use driver for the setup of and transfer of data over the AVR's SPI port.
 *
 *  @{
 */
--- a/LUFA/Drivers/Peripheral/Serial.h
+++ b/LUFA/Drivers/Peripheral/Serial.h
@ -41,7 +41,8 @@
 *    - LUFA/Drivers/Peripheral/Serial.c
 *
 *  \section Module Description
- *  Functions, macros, variables, enums and types related to the setup of the USART for serial communications.
+ *  Hardware serial USART driver. This module provides an easy to use driver for
+ *  the setup of and transfer of data over the AVR's USART port.
 *
 *  @{
 */
--- a/LUFA/Drivers/USB/USB.h
+++ b/LUFA/Drivers/USB/USB.h
@ -51,7 +51,9 @@
 *    - LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c
 *
 *  \section Module Description
- *  Functions, macros, variables, enums and types related to the management of USB communications.
+ *  Driver and framework for the USB controller hardware on the USB series of AVR microcontrollers. This module
+ *  consists of many submodules, and is designed to provide an easy way to configure and control USB host, device
+ *  or OTG mode USB applications.
 */

 /** \ingroup Group_USB
--- a/LUFA/ManPages/FutureChanges.txt
+++ b/LUFA/ManPages/FutureChanges.txt
@ -19,15 +19,12 @@
  *     -# Re-enable Host mode Class driver builds after completion
  *     -# Update Host mode Class Driver demo .txt files
  *  - Add standardized descriptor names to device and host class driver structures
-  *  - Add in INTERRUPT_CONTROL_PIPE to use HSOFI to trigger calls to the host state machine
-  *  - Debug mode for pipe/endpoint calls
  *
  *  <b>Targeted for Future Releases:</b>
  *  - Remake AVRStudio project files
  *  - Add detailed overviews of how each demo works
  *  - Master LUFA include file rather than per-module includes
  *  - Stream reads - return number of bytes not read?
-  *  - Convert CDC demos to use stdio streams?
  *  - Add multiple-report HID demo to the library
  *  - Add dual role Mouse Host/Keyboard Device demo to the library
  *  - Add hub support to match Atmel's stack
--- a/LUFA/ManPages/LUFAPoweredProjects.txt
+++ b/LUFA/ManPages/LUFAPoweredProjects.txt
@ -34,6 +34,7 @@
 *  - CAMTRIG, a remote Camera Trigger device: http://code.astraw.com/projects/motmot/camtrig
 *  - Opendous-JTAG, an open source JTAG device: http://code.google.com/p/opendous-jtag/
 *  - Openkubus, an open source hardware-based authentication dongle: http://code.google.com/p/openkubus/
+ *  - Orbee, a USB connected RGB Orb for notifications: http://www.franksworkshop.com.au/Electronics/Orbee/Orbee.htm
 *  - Reprap with LUFA, a LUFA powered 3D printer: http://code.google.com/p/at90usb1287-code-for-arduino-and-eclipse/
 *  - SEGA Megadrive/Genesis Development Cartridge: http://www.spritesmind.net/_GenDev/forum/viewtopic.php?t=464
 *  - Stripe Snoop, a Magnetic Card reader: http://www.ossguy.com/ss_usb/
--- a/LUFA/ManPages/LibraryApps.txt
+++ b/LUFA/ManPages/LibraryApps.txt
@ -6,9 +6,11 @@

 /** \page Page_LibraryApps Included Library Applications
 *
- *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.
- *  If this directory is missing, please re-download the project from the project homepage. Within this directory the demos
- *  are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the library USB Class drivers.
+ *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. Within this
+ *  directory the demos are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the
+ *  library USB Class drivers (which abstract out the actual implementation of the USB classes to simplify development even
+ *  further at the expense of a loss of flexibility).
+ *
 *  With one or two exceptions (e.g. proprietary classes such as RNDIS) all the included demos will work across all OSes without
 *  the need for special drivers. One Windows, some demos require the supplied .INF file to be used as the device driver, which
 *  directs the OS to use its inbuilt class drivers for the device.
--- a/LUFA/ManPages/MainPage.txt
+++ b/LUFA/ManPages/MainPage.txt
@ -14,7 +14,11 @@
 *  For author and donation information, see \ref Page_Donating.
 *
 *  LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license. It supports
- *  a large number of USB AVR models and boards (see \ref Page_DeviceSupport).
+ *  a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use, feature
+ *  rich framework for the development of USB peripherals and hosts.
+ *
+ *  LUFA focuses on the microcontroller side of USB development only; it includes no host USB driver development facilities. While
+ *  custom USB devices can be made with LUFA, the included demos all use the inbuilt OS drivers for each USB class for simplicity.
 *
 *  The library is currently in a stable release, suitable for download and incorporation into user projects for
 *  both host and device modes. For information about the project progression, check out my blog.
--- a/LUFA/ManPages/ProgrammingApps.txt
+++ b/LUFA/ManPages/ProgrammingApps.txt
@ -8,7 +8,7 @@
 *
 *  Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your
 *  application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the
- *  reprogramming an AVR device must be performed using a special piece of programming hardware, through one of the
+ *  reprogramming of an AVR device must be performed using a special piece of programming hardware, through one of the
 *  supported AVR programming protocols - ISP, HVSP, HVPP, JTAG or dW. This can be done through a custom programmer,
 *  a third party programmer, or an official Atmel AVR tool - for more information, see the Atmel.com website.
 *