diff options
author | Pavel Janík <Pavel@Janik.cz> | 2001-10-21 12:13:46 +0000 |
---|---|---|
committer | Pavel Janík <Pavel@Janik.cz> | 2001-10-21 12:13:46 +0000 |
commit | 8c1a1077c0f85d34684a8faa7cfd9e47bab3e610 (patch) | |
tree | 003648ba6c6530f9da222939764b76ee774bb7a3 /src/sound.c | |
parent | dfe45eff10b0f1062fae480db4d1a10a1fe33d40 (diff) | |
download | emacs-8c1a1077c0f85d34684a8faa7cfd9e47bab3e610.tar.gz |
Change doc-string comments to `new style' [w/`doc:' keyword].
Diffstat (limited to 'src/sound.c')
-rw-r--r-- | src/sound.c | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/src/sound.c b/src/sound.c index 7cbbabc185f..a5b9e77bc17 100644 --- a/src/sound.c +++ b/src/sound.c @@ -370,24 +370,24 @@ sound_cleanup (arg) DEFUN ("play-sound", Fplay_sound, Splay_sound, 1, 1, 0, - "Play sound SOUND.\n\ -SOUND is a list of the form `(sound KEYWORD VALUE...)'.\n\ -The following keywords are recognized:\n\ -\n\ - :file FILE.- read sound data from FILE. If FILE isn't an\n\ -absolute file name, it is searched in `data-directory'.\n\ -\n\ - :data DATA - read sound data from string DATA.\n\ -\n\ -Exactly one of :file or :data must be present.\n\ -\n\ - :volume VOL - set volume to VOL. VOL must an integer in the\n\ -range 0..100 or a float in the range 0..1.0. If not specified,\n\ -don't change the volume setting of the sound device.\n\ -\n\ - :device DEVICE - play sound on DEVICE. If not specified,\n\ -a system-dependent default device name is used.") - (sound) + doc: /* Play sound SOUND. +SOUND is a list of the form `(sound KEYWORD VALUE...)'. +The following keywords are recognized: + + :file FILE.- read sound data from FILE. If FILE isn't an +absolute file name, it is searched in `data-directory'. + + :data DATA - read sound data from string DATA. + +Exactly one of :file or :data must be present. + + :volume VOL - set volume to VOL. VOL must an integer in the +range 0..100 or a float in the range 0..1.0. If not specified, +don't change the volume setting of the sound device. + + :device DEVICE - play sound on DEVICE. If not specified, +a system-dependent default device name is used. */) + (sound) Lisp_Object sound; { Lisp_Object attrs[SOUND_ATTR_SENTINEL]; |