Application documentation/comment cleanup.

git-svn-id: http://lufa-lib.googlecode.com/svn/trunk@862 d5102386-fcda-11dd-9fdb-3debd5008f28

14 files changed, 15 insertions, 20 deletions

diff --git a/Demos/Device/LowLevel/CDC/CDC.c b/Demos/Device/LowLevel/CDC/CDC.c
index 0c98c11a..444dc019 100644
--- a/Demos/Device/LowLevel/CDC/CDC.c
+++ b/Demos/Device/LowLevel/CDC/CDC.c
@@ -36,7 +36,6 @@
 

 #include "CDC.h"

 

-/* Globals: */

 /** Contains the current baud rate and other settings of the virtual serial port. While this demo does not use

  *  the physical USART and thus does not use these settings, they must still be retained and returned to the host

  *  upon request or the host will assume the device is non-functional.

@@ -50,6 +49,7 @@ CDC_Line_Coding_t LineEncoding = { .BaudRateBPS = 0,
                                    .ParityType  = Parity_None,

                                    .DataBits    = 8            };

 

+

 #if 0

 /* NOTE: Here you can set up a standard stream using the created virtual serial port, so that the standard stream functions in

  *       <stdio.h> can be used on the virtual serial port (e.g. fprintf(&USBSerial, "Test"); to print a string).

diff --git a/Demos/Device/LowLevel/DualCDC/DualCDC.c b/Demos/Device/LowLevel/DualCDC/DualCDC.c
index efbecd6c..8b1da034 100644
--- a/Demos/Device/LowLevel/DualCDC/DualCDC.c
+++ b/Demos/Device/LowLevel/DualCDC/DualCDC.c
@@ -36,7 +36,6 @@
  

 #include "DualCDC.h"

 

-/* Globals: */

 /** Contains the current baud rate and other settings of the first virtual serial port. While this demo does not use

  *  the physical USART and thus does not use these settings, they must still be retained and returned to the host

  *  upon request or the host will assume the device is non-functional.

@@ -63,8 +62,9 @@ CDC_Line_Coding_t LineEncoding2 = { .BaudRateBPS = 0,
                                     .ParityType  = Parity_None,

                                     .DataBits    = 8            };

 

+

 /** Main program entry point. This routine configures the hardware required by the application, then

- *  starts the scheduler to run the application tasks.

+ *  enters a loop to run the application tasks in sequence.

  */

 int main(void)

 {

diff --git a/Demos/Device/LowLevel/GenericHID/GenericHID.c b/Demos/Device/LowLevel/GenericHID/GenericHID.c
index 5a8bb518..034635d7 100644
--- a/Demos/Device/LowLevel/GenericHID/GenericHID.c
+++ b/Demos/Device/LowLevel/GenericHID/GenericHID.c
@@ -41,7 +41,7 @@ static uint8_t LastReceived[GENERIC_REPORT_SIZE];
 

 

 /** Main program entry point. This routine configures the hardware required by the application, then

- *  starts the scheduler to run the USB management task.

+ *  enters a loop to run the application tasks in sequence.

  */

 int main(void)

 {

diff --git a/Demos/Device/LowLevel/Joystick/Joystick.c b/Demos/Device/LowLevel/Joystick/Joystick.c
index 306baa9e..6d04c8fa 100644
--- a/Demos/Device/LowLevel/Joystick/Joystick.c
+++ b/Demos/Device/LowLevel/Joystick/Joystick.c
@@ -37,7 +37,7 @@
 #include "Joystick.h"

 

 /** Main program entry point. This routine configures the hardware required by the application, then

- *  starts the scheduler to run the application tasks.

+ *  enters a loop to run the application tasks in sequence.

  */

 int main(void)

 {

diff --git a/Demos/Device/LowLevel/Keyboard/Keyboard.c b/Demos/Device/LowLevel/Keyboard/Keyboard.c
index 02f61a52..32765af3 100644
--- a/Demos/Device/LowLevel/Keyboard/Keyboard.c
+++ b/Demos/Device/LowLevel/Keyboard/Keyboard.c
@@ -37,7 +37,6 @@
  

 #include "Keyboard.h"

 

-/* Global Variables */

 /** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot

  *  protocol reporting mode.

  */

@@ -56,7 +55,7 @@ uint16_t IdleMSRemaining = 0;
 

 

 /** Main program entry point. This routine configures the hardware required by the application, then

- *  starts the scheduler to run the USB management task.

+ *  enters a loop to run the application tasks in sequence.

  */

 int main(void)

 {

diff --git a/Demos/Device/LowLevel/KeyboardMouse/KeyboardMouse.c b/Demos/Device/LowLevel/KeyboardMouse/KeyboardMouse.c
index bfd337a2..9bd92686 100644
--- a/Demos/Device/LowLevel/KeyboardMouse/KeyboardMouse.c
+++ b/Demos/Device/LowLevel/KeyboardMouse/KeyboardMouse.c
@@ -37,15 +37,15 @@
  

 #include "KeyboardMouse.h"

 

-/* Global Variables */

 /** Global structure to hold the current keyboard interface HID report, for transmission to the host */

 USB_KeyboardReport_Data_t KeyboardReportData;

 

 /** Global structure to hold the current mouse interface HID report, for transmission to the host */

 USB_MouseReport_Data_t    MouseReportData;

 

+

 /** Main program entry point. This routine configures the hardware required by the application, then

- *  starts the scheduler to run the USB management task.

+ *  enters a loop to run the application tasks in sequence.

  */

 int main(void)

 {

diff --git a/Demos/Device/LowLevel/MIDI/MIDI.c b/Demos/Device/LowLevel/MIDI/MIDI.c
index c4ec8941..2cdf7115 100644
--- a/Demos/Device/LowLevel/MIDI/MIDI.c
+++ b/Demos/Device/LowLevel/MIDI/MIDI.c
@@ -37,7 +37,7 @@
 #include "MIDI.h"

 

 /** Main program entry point. This routine configures the hardware required by the application, then

- *  starts the scheduler to run the application tasks.

+ *  enters a loop to run the application tasks in sequence.

  */

 int main(void)

 {

diff --git a/Demos/Device/LowLevel/MassStorage/MassStorage.c b/Demos/Device/LowLevel/MassStorage/MassStorage.c
index 76aa337c..c41b5777 100644
--- a/Demos/Device/LowLevel/MassStorage/MassStorage.c
+++ b/Demos/Device/LowLevel/MassStorage/MassStorage.c
@@ -37,7 +37,6 @@
 #define  INCLUDE_FROM_MASSSTORAGE_C

 #include "MassStorage.h"

 

-/* Global Variables */

 /** Structure to hold the latest Command Block Wrapper issued by the host, containing a SCSI command to execute. */

 CommandBlockWrapper_t  CommandBlock;

 

@@ -47,8 +46,9 @@ CommandStatusWrapper_t CommandStatus = { .Signature = CSW_SIGNATURE };
 /** Flag to asynchronously abort any in-progress data transfers upon the reception of a mass storage reset command. */

 volatile bool          IsMassStoreReset = false;

 

+

 /** Main program entry point. This routine configures the hardware required by the application, then

- *  starts the scheduler to run the application tasks.

+ *  enters a loop to run the application tasks in sequence.

  */

 int main(void)

 {

diff --git a/Demos/Device/LowLevel/Mouse/Mouse.c b/Demos/Device/LowLevel/Mouse/Mouse.c
index aa95e9c0..2f7a63f7 100644
--- a/Demos/Device/LowLevel/Mouse/Mouse.c
+++ b/Demos/Device/LowLevel/Mouse/Mouse.c
@@ -36,7 +36,6 @@
  

 #include "Mouse.h"

 

-/* Global Variables */

 /** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot

  *  protocol reporting mode.

  */

@@ -55,7 +54,7 @@ uint16_t IdleMSRemaining = 0;
 

 

 /** Main program entry point. This routine configures the hardware required by the application, then

- *  starts the scheduler to run the application tasks.

+ *  enters a loop to run the application tasks in sequence.

  */

 int main(void)

 {

diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.c b/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.c
index 2856131c..debd322e 100644
--- a/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.c
+++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.c
@@ -37,7 +37,6 @@
  

 #include "Ethernet.h"

 

-/* Global Variables: */

 /** Ethernet Frame buffer structure, to hold the incoming Ethernet frame from the host. */

 Ethernet_Frame_Info_t FrameIN;

 

diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c b/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c
index ced33390..910191d6 100644
--- a/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c
+++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c
@@ -37,7 +37,6 @@
 #define  INCLUDE_FROM_RNDIS_C

 #include "RNDIS.h"

 

-/* Global Variables: */

 /** Physical MAC address of the network adapter, which becomes the MAC address of the host for packets sent to the adapter. */

 static MAC_Address_t  PROGMEM AdapterMACAddress          = {ADAPTER_MAC_ADDRESS};

 

diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c b/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c
index 2537286b..06f0c696 100644
--- a/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c
+++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c
@@ -38,7 +38,6 @@
 #define  INCLUDE_FROM_TCP_C

 #include "TCP.h"

 

-/* Global Variables: */

 /** Port state table array. This contains the current status of TCP ports in the device. To save on space, only open ports are

  *  stored - closed ports may be overwritten at any time, and the system will assume any ports not present in the array are closed. This

  *  allows for MAX_OPEN_TCP_PORTS to be less than the number of ports used by the application if desired.

diff --git a/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.c b/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.c
index b722187c..4c75e5d8 100644
--- a/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.c
+++ b/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.c
@@ -37,7 +37,7 @@
 #include "RNDISEthernet.h"

 

 /** Main program entry point. This routine configures the hardware required by the application, then

- *  starts the scheduler to run the USB management task.

+ *  enters a loop to run the application tasks in sequence.

  */

 int main(void)

 {

diff --git a/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.c b/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.c
index 92449a67..577d2ba6 100644
--- a/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.c
+++ b/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.c
@@ -30,7 +30,6 @@
 

 #include "USBtoSerial.h"

 

-/* Globals: */

 /** Contains the current baud rate and other settings of the virtual serial port.

  *

  *  These values are set by the host via a class-specific request, and the physical USART should be reconfigured to match the

@@ -50,8 +49,9 @@ RingBuff_t Tx_Buffer;
 /** Flag to indicate if the USART is currently transmitting data from the Rx_Buffer circular buffer. */

 volatile bool Transmitting = false;

 

+

 /** Main program entry point. This routine configures the hardware required by the application, then

- *  starts the scheduler to run the application tasks.

+ *  enters a loop to run the application tasks in sequence.

  */

 int main(void)

 {