Mercurial > octave-nkf
diff doc/interpreter/audio.txi @ 19605:72304a4e010a
Use Octave coding conventions for documentation of audio functions.
* audio.txi, audioread.cc, @audioplayer/audioplayer.m, @audioplayer/get.m,
@audioplayer/play.m, @audioplayer/playblocking.m, @audioplayer/set.m,
@audiorecorder/audiorecorder.m, @audiorecorder/get.m,
@audiorecorder/getaudiodata.m, @audiorecorder/play.m, @audiorecorder/record.m,
@audiorecorder/set.m:
Use Octave documentation standards.
* audiodevinfo.cc: Limit lines to 80 chars. Indent according to GNU style.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 13 Jan 2015 08:54:25 -0800 |
| parents | 651f12640c90 |
| children | 0e1f5a750d00 |
line wrap: on
line diff
--- a/doc/interpreter/audio.txi Tue Jan 13 12:50:43 2015 +0100 +++ b/doc/interpreter/audio.txi Tue Jan 13 08:54:25 2015 -0800 @@ -33,7 +33,7 @@ @section Audio File Utilities The following functions allow you to read, write and retrieve -information about audio files. Various formats are supported including +information about audio files. Various formats are supported including wav, flac and ogg vorbis. @DOCSTRING(audioinfo) @@ -51,8 +51,8 @@ @section Audio Player The following methods are used to create and use audioplayer -objects. These objects can be used to play back audio data stored in -Octave matrices and arrays. The audioplayer object supports playback +objects. These objects can be used to play back audio data stored in +Octave matrices and arrays. The audioplayer object supports playback from various devices available to the system, blocking and non-blocking playback, convenient pausing and resuming and much more. @@ -94,10 +94,10 @@ @section Audio Recorder The following methods are used to create and use audiorecorder -objects. These objects can be used to record audio data from various -devices available to the system. You can use convenient methods to +objects. These objects can be used to record audio data from various +devices available to the system. You can use convenient methods to retrieve that data or audioplayer objects created from that -data. Methods for blocking and non-blocking recording, pausing and +data. Methods for blocking and non-blocking recording, pausing and resuming recording and much more is available. @DOCSTRING(@audiorecorder/audiorecorder)