just some cleanup

- replaced many German and Polish comments
- replaced many cryptic var-names
- IlNut replaced with LengthNote
- renamed the global var "Filename" to "ConversionFilename" to prevent unintended use of it
- more readable code (hopefully), especially NewNote and OnSentenceEnd
- added some comments on elementary classes/records and their fields

git-svn-id: svn://svn.code.sf.net/p/ultrastardx/svn/trunk@1137 b956fd51-792f-4845-bead-9b4dfca2ff2c

1 files changed, 15 insertions, 0 deletions

diff --git a/Game/Code/Classes/UIni.pas b/Game/Code/Classes/UIni.pas
index 0f31649c..5e651be0 100644
--- a/Game/Code/Classes/UIni.pas
+++ b/Game/Code/Classes/UIni.pas
@@ -15,6 +15,21 @@ uses
   SysUtils;
 
 type
+  // TInputDeviceConfig stores the configuration for an input device.
+  // Configurations will be stored in the InputDeviceConfig array.
+  // Note that not all devices listed in InputDeviceConfig are active devices.
+  // Some might be unplugged and hence unavailable.
+  // Available devices are held in TAudioInputProcessor.DeviceList. Each
+  // TAudioInputDevice listed there has a CfgIndex field which is the index to
+  // its configuration in the InputDeviceConfig array.
+  // Name:
+  //   the name of the input device
+  // Input:
+  //   the index of the input source to use for recording
+  // ChannelToPlayerMap:
+  //   mapping of recording channels to players, e.g. ChannelToPlayerMap[0] = 2
+  //   maps the channel 0 (left) to player 2. A player index of 0 means that
+  //   the channel is not assigned to a player.
   PInputDeviceConfig = ^TInputDeviceConfig;
   TInputDeviceConfig = record
     Name:               string;