Minor documentation corrections.
authorDean Camera <dean@fourwalledcubicle.com>
Wed, 15 Sep 2010 00:30:40 +0000 (00:30 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Wed, 15 Sep 2010 00:30:40 +0000 (00:30 +0000)
LUFA/ManPages/ConfiguringApps.txt
LUFA/ManPages/LUFAPoweredProjects.txt
LUFA/ManPages/LibraryApps.txt
LUFA/ManPages/MigrationInformation.txt
LUFA/ManPages/VIDAndPIDValues.txt
LUFA/makefile

index 058d79b..f601efa 100644 (file)
@@ -6,11 +6,11 @@
  
 /** \page Page_ConfiguringApps Configuring the Demos, Bootloaders and Projects
  *
- *  If the target AVR model, clock speed, board or other settings are different to the current settings, they must be changed
+ *  If the target AVR model, clock speed, board or other settings are different from the current settings, they must be changed
  *  and the project recompiled from the source code before being programmed into the AVR microcontroller. Most project
  *  configuration options are located in the "makefile" build script inside each LUFA application's folder, however some
- *  demo or application-specific configuration settings (such as the output format in the AudioOut demo) are located in the
- *  main .c source file of the project. See each project's individual documentation for application-specific configuration
+ *  demo or application-specific configuration settings (such as the output format in the AudioOut demo) are located in one or
+ *  more of the source files of the project. See each project's individual documentation for application-specific configuration
  *  values.
  *
  *  Each project "makefile" contains all the script and configuration data required to compile each project. When opened with
@@ -20,7 +20,7 @@
  *  Inside each makefile, a number of configuration variables are located, with the format "<VARIABLE NAME> = <VALUE>". For
  *  each application, the important variables which should be altered are:
  *
- *    - <b>MCU</b>, the target AVR processor.
+ *    - <b>MCU</b>, the target AVR processor
  *    - <b>BOARD</b>, the target board hardware
  *    - <b>F_CLOCK</b>, the target raw master clock frequency, before any prescaling is performed
  *    - <b>F_CPU</b>, the target AVR CPU master clock frequency, after any prescaling
@@ -35,7 +35,7 @@
  *  (such as the AT90USB1287, or the ATMEGA32U4), in all lower-case (e.g. "at90usb1287"). Note that not all demos support all the
  *  USB AVR models, as they may make use of peripherals or modes only present in some devices.
  *
- *  For supported library AVR models, see main documentation page.
+ *  For supported processor models, see \ref Page_DeviceSupport.
  *
  *  \section Sec_BOARD The BOARD Parameter
  *  This parameter indicates the target AVR board hardware for the compiled application. Some LUFA library drivers are board-specific,
@@ -48,6 +48,8 @@
  *  directory into a /Board/ folder inside the application directory, and the stub driver completed with the appropriate code to drive the
  *  custom board's hardware.
  *
+ *  For boards with built in hardware driver support within the LUFA library, see \ref Page_DeviceSupport.
+ *
  *  \section Sec_F_CLOCK The F_CLOCK Parameter
  *  This parameter indicates the target AVR's input clock frequency, in Hz. This is the actual clock input, before any prescaling is performed. In the
  *  USB AVR architecture, the input clock before any prescaling is fed directly to the PLL subsystem, and thus the PLL is derived directly from the
index 0563462..2d2c7da 100644 (file)
@@ -55,6 +55,7 @@
  *  - Linux Secure Storage Dongle: http://github.com/TomMD/teensy
  *  - MakeTV Episode Dispenser: http://www.youtube.com/watch?v=BkWUi18hl3g
  *  - MidiMonster, a USB-to-MIDI gateway board: http://www.dorkbotpdx.org/wiki/midimonster
+ *  - Mobo 4.3, a USB controlled all band (160-10m) HF SDR transceiver: http://sites.google.com/site/lofturj/mobo4_3
  *  - NES Controller USB modification: http://projects.peterpolidoro.net/video/NESUSB.htm
  *  - Opendous-JTAG, an open source ARM JTAG debugger: http://code.google.com/p/opendous-jtag/
  *  - Openkubus, an open source hardware-based authentication dongle: http://code.google.com/p/openkubus/
@@ -80,7 +81,6 @@
  *  - Penguino, an Arduino Board With On-Board LUFA Powered Debugger/Programmer: http://wiki.icy.com.au/PenguinoAVR
  *  - Many of Busware's Products: http://www.busware.de/
  *  - MIDIFighter, a USB-MIDI controller: http://www.midifighter.com/
- *  - Mobo 4.3, a USB controlled all band (160-10m) HF SDR transceiver: http://sites.google.com/site/lofturj/mobo4_3
  *  - Retrode, a USB Games Console Cartridge Reader: http://www.retrode.org
  *  - USBTINY-MKII, an AVRISP-MKII Clone AVR Programmer: http://tom-itx.dyndns.org:81/~webpage/boards/USBTiny_Mkii/USBTiny_Mkii_index.php
  *  - XMEGA Development Board, using LUFA as an On-Board Programmer: http://xmega.mattair.net/
index 787847f..2a6159a 100644 (file)
  *    - <b>Webserver</b> - RNDIS Host Webserver with DHCP client, powered by uIP TCP/IP stack project and FatFS library
  *    - <b>XPLAINBridge</b> - XPLAIN alternative PDI Programmer/USB to Serial Bridge firmware project
  *    - <b>Incomplete</b>
- *      - <b>MIDIToneGenerator</b> - Incomplete MIDI Tone Generator application, to convert MIDI note messages into audio tones
  *      - <b>StandaloneProgrammer</b> - Incomplete Standalone AVR Programmer application, to program AVRs directly from a Mass Storage disk
  *
  *  </small>
index 54cb6eb..c0efcbd 100644 (file)
@@ -10,7 +10,7 @@
  *  to the next version released. It does not indicate all new additions to the library in each version change, only
  *  areas relevant to making older projects compatible with the API changes of each new release.
  *
- * \section Sec_MigrationXXXXXX Migrating from XXXXXX to XXXXXX
+ * \section Sec_MigrationXXXXXX Migrating from 100807 to XXXXXX
  *  <b>USB Core</b>
  *    - A new USB driver source file, Drivers/USB/HighLevel/EndpointStream.c now exists. This source file should be added
  *      to all project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source
index 41ad560..9f4183e 100644 (file)
@@ -14,7 +14,7 @@
  *  <b>These VID/PID values should not be used in commercial designs under any circumstances.</b> Private projects
  *  may use the following values freely, but must accept any collisions due to other LUFA derived private projects
  *  sharing identical values. It is suggested that private projects using interfaces compatible with existing
- *  demos share the save VID/PID value.
+ *  demos share the same VID/PID value.
  *
  *  <table>
  *
index c6ca8b4..2dbecaf 100644 (file)
@@ -53,10 +53,10 @@ LUFA_SRC_SCHEDULER    = $(LUFA_ROOT_PATH)/Scheduler/Scheduler.c
 
 # Check to see if the LUFA_PATH variable has not been set (the makefile is not being included from a project makefile)
 ifeq ($(origin LUFA_PATH), undefined)
-   LUFA_SRC_ALL_FILES  = $(LUFA_SRC_USB) $(LUFA_SRC_USBCLASS)       \
-                         $(LUFA_SRC_TEMPERATURE) $(LUFA_SRC_SERIAL) \
-                         $(LUFA_SRC_SERIALSTREAM) $(LUFA_SRC_TWI)   \
-                         $(LUFA_SRC_SCHEDULER)
+   LUFA_SRC_ALL_FILES = $(LUFA_SRC_USB) $(LUFA_SRC_USBCLASS)       \
+                        $(LUFA_SRC_TEMPERATURE) $(LUFA_SRC_SERIAL) \
+                        $(LUFA_SRC_SERIALSTREAM) $(LUFA_SRC_TWI)   \
+                        $(LUFA_SRC_SCHEDULER)
 
    all: