Doc: annotate the sound ids by their usage, instead of what they soun…

…d like subjectively.

src/sound_type.h

@@ -36,79 +36,79 @@ struct SoundEntry {
  */
 enum SoundFx {
 	SND_BEGIN = 0,
-	SND_02_SPLAT_WATER = 0,                ///< Water construction.
-	SND_03_FACTORY_WHISTLE,
-	SND_04_TRAIN,
-	SND_05_TRAIN_THROUGH_TUNNEL,
-	SND_06_SHIP_HORN,
-	SND_07_FERRY_HORN,
-	SND_08_PLANE_TAKE_OFF,
-	SND_09_JET,
-	SND_0A_TRAIN_HORN,
-	SND_0B_MINING_MACHINERY,
-	SND_0C_ELECTRIC_SPARK,
-	SND_0D_STEAM,
-	SND_0E_LEVEL_CROSSING,
-	SND_0F_VEHICLE_BREAKDOWN,
-	SND_10_TRAIN_BREAKDOWN,
-	SND_11_CRASH,
-	SND_12_EXPLOSION,                      // 16 == 0x10
-	SND_13_BIG_CRASH,
-	SND_14_CASHTILL,
-	SND_15_BEEP,                           // 19 == 0x13
-	SND_16_MORSE,                          // 20 == 0x14
-	SND_17_SKID_PLANE,
-	SND_18_HELICOPTER,
-	SND_19_BUS_START_PULL_AWAY,
-	SND_1A_BUS_START_PULL_AWAY_WITH_HORN,
-	SND_1B_TRUCK_START,
-	SND_1C_TRUCK_START_2,
-	SND_1D_APPLAUSE,
-	SND_1E_OOOOH,
-	SND_1F_SPLAT_OTHER,                    ///< Non-water non-rail construction.
-	SND_20_SPLAT_RAIL,                     ///< Rail construction.
-	SND_21_JACKHAMMER,
-	SND_22_CAR_HORN,
-	SND_23_CAR_HORN_2,
-	SND_24_SHEEP,
-	SND_25_COW,
-	SND_26_HORSE,
-	SND_27_BLACKSMITH_ANVIL,
-	SND_28_SAWMILL,                        // 38 == 0x26 !
-	SND_00_GOOD_YEAR,                      // 39 == 0x27 !
-	SND_01_BAD_YEAR,                       // 40 == 0x28 !
-	SND_29_RIP,                            // 41 == 0x29 !
-	SND_2A_EXTRACT_AND_POP,
-	SND_2B_COMEDY_HIT,
-	SND_2C_MACHINERY,
-	SND_2D_RIP_2,
-	SND_2E_EXTRACT_AND_POP,
-	SND_2F_POP,
-	SND_30_CARTOON_SOUND,
-	SND_31_EXTRACT,
-	SND_32_POP_2,
-	SND_33_PLASTIC_MINE,
-	SND_34_WIND,
-	SND_35_COMEDY_BREAKDOWN,
-	SND_36_CARTOON_CRASH,
-	SND_37_BALLOON_SQUEAK,
-	SND_38_CHAINSAW,
-	SND_39_HEAVY_WIND,
-	SND_3A_COMEDY_BREAKDOWN_2,
-	SND_3B_JET_OVERHEAD,
-	SND_3C_COMEDY_CAR,
-	SND_3D_ANOTHER_JET_OVERHEAD,
-	SND_3E_COMEDY_CAR_2,
-	SND_3F_COMEDY_CAR_3,
-	SND_40_COMEDY_CAR_START_AND_PULL_AWAY,
-	SND_41_MAGLEV,
-	SND_42_LOON_BIRD,
-	SND_43_LION,
-	SND_44_MONKEYS,
-	SND_45_PLANE_CRASHING,
-	SND_46_PLANE_ENGINE_SPUTTERING,
-	SND_47_MAGLEV_2,
-	SND_48_DISTANT_BIRD,                    // 72 == 0x48
+	SND_02_SPLAT_WATER = 0,                ///<  0 == 0x00  Water construction
+	SND_03_FACTORY_WHISTLE,                ///<  1 == 0x01  Factory production
+	SND_04_TRAIN,                          ///<  2 == 0x02  Steam engine
+	SND_05_TRAIN_THROUGH_TUNNEL,           ///<  3 == 0x03  Train enter tunnel
+	SND_06_SHIP_HORN,                      ///<  4 == 0x04  Cargo ships
+	SND_07_FERRY_HORN,                     ///<  5 == 0x05  Passenger ships
+	SND_08_PLANE_TAKE_OFF,                 ///<  6 == 0x06  Propeller plane
+	SND_09_JET,                            ///<  7 == 0x07  Regular jet plane
+	SND_0A_TRAIN_HORN,                     ///<  8 == 0x08  Diesel and electric engine
+	SND_0B_MINING_MACHINERY,               ///<  9 == 0x09  Coal/copper/gold mine: animation
+	SND_0C_ELECTRIC_SPARK,                 ///< 10 == 0x0A  Power plant: animation
+	SND_0D_STEAM,                          ///< 11 == 0x0B  unused 1
+	SND_0E_LEVEL_CROSSING,                 ///< 12 == 0x0C  Train passes through level crossing
+	SND_0F_VEHICLE_BREAKDOWN,              ///< 13 == 0x0D  Road vehicle breakdown
+	SND_10_TRAIN_BREAKDOWN,                ///< 14 == 0x0E  Train or ship breakdown
+	SND_11_CRASH,                          ///< 15 == 0x0F  unused 2
+	SND_12_EXPLOSION,                      ///< 16 == 0x10  Destruction, crashes, disasters, ...
+	SND_13_BIG_CRASH,                      ///< 15 == 0x11  Train+train crash
+	SND_14_CASHTILL,                       ///< 18 == 0x12  Income from cargo delivery
+	SND_15_BEEP,                           ///< 19 == 0x13  GUI button click
+	SND_16_MORSE,                          ///< 20 == 0x14  News ticker
+	SND_17_SKID_PLANE,                     ///< 21 == 0x15  Plane landing
+	SND_18_HELICOPTER,                     ///< 22 == 0x16  Helicopter
+	SND_19_BUS_START_PULL_AWAY,            ///< 23 == 0x17  Truck and old bus 1
+	SND_1A_BUS_START_PULL_AWAY_WITH_HORN,  ///< 24 == 0x18  Truck and old bus 2 (random variation of SND_19_BUS_START_PULL_AWAY)
+	SND_1B_TRUCK_START,                    ///< 25 == 0x19  Modern bus
+	SND_1C_TRUCK_START_2,                  ///< 26 == 0x1A  Old bus
+	SND_1D_APPLAUSE,                       ///< 27 == 0x1B  News: first vehicle at station
+	SND_1E_OOOOH,                          ///< 28 == 0x1C  News: new vehicle
+	SND_1F_SPLAT_OTHER,                    ///< 29 == 0x1D  Non-water non-rail construction
+	SND_20_SPLAT_RAIL,                     ///< 30 == 0x1E  Rail construction
+	SND_21_JACKHAMMER,                     ///< 31 == 0x1F  Road reconstruction.
+	SND_22_CAR_HORN,                       ///< 32 == 0x20  unused 3
+	SND_23_CAR_HORN_2,                     ///< 33 == 0x21  unused 4
+	SND_24_SHEEP,                          ///< 34 == 0x22  Farm production 1
+	SND_25_COW,                            ///< 35 == 0x23  Farm production 2
+	SND_26_HORSE,                          ///< 36 == 0x24  Farm production 2
+	SND_27_BLACKSMITH_ANVIL,               ///< 37 == 0x25  Bridge construction
+	SND_28_SAWMILL,                        ///< 38 == 0x26  Sawmill production
+	SND_00_GOOD_YEAR,                      ///< 39 == 0x27  New year. Performance was better than previous year.
+	SND_01_BAD_YEAR,                       ///< 40 == 0x28  New year. Performance was worse than previous year.
+	SND_29_RIP,                            ///< 41 == 0x29  Sugar mine: animation 2
+	SND_2A_EXTRACT_AND_POP,                ///< 42 == 0x2A  Toy factory: animation 3
+	SND_2B_COMEDY_HIT,                     ///< 43 == 0x2B  Toy factory: animation 2
+	SND_2C_MACHINERY,                      ///< 44 == 0x2C  Toy factory: animation 1
+	SND_2D_RIP_2,                          ///< 45 == 0x2D  Sugar mine: animation 1
+	SND_2E_EXTRACT_AND_POP,                ///< 46 == 0x2E  Bubble generator: generate bubble
+	SND_2F_POP,                            ///< 47 == 0x2F  Bubble generator: bubble pop
+	SND_30_CARTOON_SOUND,                  ///< 48 == 0x30  Toffee quary: animation
+	SND_31_EXTRACT,                        ///< 49 == 0x31  Bubble generator: bubble slurped
+	SND_32_POP_2,                          ///< 50 == 0x32  unused 5
+	SND_33_PLASTIC_MINE,                   ///< 51 == 0x33  Plastic fountain production
+	SND_34_WIND,                           ///< 52 == 0x34  Arctic snow ambient 1
+	SND_35_COMEDY_BREAKDOWN,               ///< 53 == 0x35  Toyland road vehicle breakdown
+	SND_36_CARTOON_CRASH,                  ///< 54 == 0x36  Lumbermill: cut tree 3
+	SND_37_BALLOON_SQUEAK,                 ///< 55 == 0x37  Lumbermill: cut tree 2
+	SND_38_CHAINSAW,                       ///< 56 == 0x38  Lumbermill: cut tree 1
+	SND_39_HEAVY_WIND,                     ///< 57 == 0x39  Arctic snow ambient 2
+	SND_3A_COMEDY_BREAKDOWN_2,             ///< 58 == 0x3A  Toyland train or ship breakdown
+	SND_3B_JET_OVERHEAD,                   ///< 59 == 0x3B  Supersonic plane (fast)
+	SND_3C_COMEDY_CAR,                     ///< 60 == 0x3C  Toyland bus 1
+	SND_3D_ANOTHER_JET_OVERHEAD,           ///< 61 == 0x3D  Huge jet plane (high capacity)
+	SND_3E_COMEDY_CAR_2,                   ///< 62 == 0x3E  Toyland bus 2
+	SND_3F_COMEDY_CAR_3,                   ///< 63 == 0x3F  Toyland truck 1
+	SND_40_COMEDY_CAR_START_AND_PULL_AWAY, ///< 64 == 0x40  Toyland truck 2
+	SND_41_MAGLEV,                         ///< 65 == 0x41  Maglev engine
+	SND_42_LOON_BIRD,                      ///< 66 == 0x42  Rainforest ambient 1
+	SND_43_LION,                           ///< 67 == 0x43  Rainforest ambient 2
+	SND_44_MONKEYS,                        ///< 68 == 0x44  Rainforest ambient 3
+	SND_45_PLANE_CRASHING,                 ///< 69 == 0x45  Toyland propeller plane 1
+	SND_46_PLANE_ENGINE_SPUTTERING,        ///< 70 == 0x46  Toyland propeller plane 2
+	SND_47_MAGLEV_2,                       ///< 71 == 0x47  Monorail engine
+	SND_48_DISTANT_BIRD,                   ///< 72 == 0x48  Rainforest ambient 4
 	SND_END
 };