revised commandline option comments for better categorization when sorted

[xonotic/darkplaces.git] / snd_win.c

diff --git a/snd_win.c b/snd_win.c
index bea76b5683fb526ac51bb5c55fbad672c8ed904f..a66bae5cc935379d0631fe0c6291869bed0df6c1 100644 (file)
--- a/snd_win.c
+++ b/snd_win.c
@@ -196,7 +196,8 @@ sndinitstat SNDDMA_InitDirect (void)
        memset((void *)shm, 0, sizeof(*shm));
        shm->format.channels = 2;
        shm->format.width = 2;
-       i = COM_CheckParm ("-sndspeed"); // LordHavoc: -sndspeed option
+// COMMANDLINEOPTION: Windows Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate
+       i = COM_CheckParm ("-sndspeed");
        if (i && i != (com_argc - 1))
                shm->format.speed = atoi(com_argv[i+1]);
        else
@@ -282,6 +283,7 @@ sndinitstat SNDDMA_InitDirect (void)
        dsbcaps.dwSize = sizeof(dsbcaps);
        primary_format_set = false;
 
+// COMMANDLINEOPTION: Windows DirectSound: -snoforceformat uses the format that DirectSound returns, rather than forcing it
        if (!COM_CheckParm ("-snoforceformat"))
        {
                if (DS_OK == pDS->lpVtbl->CreateSoundBuffer(pDS, &dsbuf, &pDSPBuf, NULL))
@@ -303,6 +305,7 @@ sndinitstat SNDDMA_InitDirect (void)
                }
        }
 
+// COMMANDLINEOPTION: Windows DirectSound: -primarysound locks the sound hardware for exclusive use
        if (!primary_format_set || !COM_CheckParm ("-primarysound"))
        {
        // create the secondary buffer we'll actually work with
@@ -428,6 +431,7 @@ qboolean SNDDMA_InitWav (void)
        memset((void *)shm, 0, sizeof(*shm));
        shm->format.channels = 2;
        shm->format.width = 2;
+// COMMANDLINEOPTION: Windows Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate
        i = COM_CheckParm ("-sndspeed"); // LordHavoc: -sndspeed option
        if (i && i != (com_argc - 1))
                shm->format.speed = atoi(com_argv[i+1]);
@@ -554,6 +558,7 @@ qboolean SNDDMA_Init(void)
 {
        sndinitstat     stat;
 
+// COMMANDLINEOPTION: Windows Sound: -wavonly uses wave sound instead of DirectSound
        if (COM_CheckParm ("-wavonly"))
                wavonly = true;
 
@@ -566,7 +571,7 @@ qboolean SNDDMA_Init(void)
        {
                if (snd_firsttime || snd_isdirect)
                {
-                       stat = SNDDMA_InitDirect ();;
+                       stat = SNDDMA_InitDirect ();
 
                        if (stat == SIS_SUCCESS)
                        {