Mercurial > octave-nkf

changeset 19519:b3399e03eb21

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: short descriptions in audiodevinfo.txi and audiofile.txi for the functions
author Vytautas Jančauskas <unaudio@gmail.com>
date Tue, 17 Sep 2013 20:58:35 +0300
parents d24bf3fb4c09
children 316a5606f74f
files doc/interpreter/audiodevinfo.txi doc/interpreter/audiofile.txi
diffstat 2 files changed, 5 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/audiodevinfo.txi	Tue Sep 17 20:53:11 2013 +0300
+++ b/doc/interpreter/audiodevinfo.txi	Tue Sep 17 20:58:35 2013 +0300
@@ -1,4 +1,6 @@
 @node Audio Device Information
 @section Audio Device Information
 
+This function is used to get information about audio devices that are available on your system. This information can then be used when creating audioplayer and audiorecorder objects.
+
 @DOCSTRING(audiodevinfo)
\ No newline at end of file
--- a/doc/interpreter/audiofile.txi	Tue Sep 17 20:53:11 2013 +0300
+++ b/doc/interpreter/audiofile.txi	Tue Sep 17 20:58:35 2013 +0300
@@ -4,5 +4,8 @@
 The following functions provide functionality for reading and writing audio files in various formats including .wav, .flag, .ogg and many others. Also for retrieving information about audio files, such as number of channels, sampling rate, metadata and other.
 
 @DOCSTRING(audioinfo)
+
+The following two functions read and write audio files.
+
 @DOCSTRING(audioread)
 @DOCSTRING(audiowrite)
\ No newline at end of file