Mercurial > octave-nkf

diff libinterp/dldfcn/audioread.cc @ 19605:72304a4e010a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 701b43ce4467
children 793d295fed4d
line wrap: on
line diff
--- a/libinterp/dldfcn/audioread.cc	Tue Jan 13 12:50:43 2015 +0100
+++ b/libinterp/dldfcn/audioread.cc	Tue Jan 13 08:54:25 2015 -0800
@@ -50,8 +50,8 @@
 #endif
 
 DEFUN_DLD (audioread, args, ,
-  "-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename})\n\
+           "-*- texinfo -*-\n\
+@deftypefn  {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename})\n\
 @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{samples})\n\
 \n\
 @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{datatype})\n\
@@ -67,7 +67,8 @@
 If it is @qcode{\"native\"}, then the type of data depends on how the\n\
 data is stored in the audio file.\n\
 \n\
-Read a file and return a specified range of frames in an array of specified type.\n\
+Read a file and return a specified range of frames in an array of specified\n\
+type.\n\
 \n\
 @end deftypefn")
 {
@@ -87,7 +88,7 @@
 
   if (error_state)
     return retval;
-  
+
   SF_INFO info;
   info.format = 0;
   SNDFILE *file = sf_open (filename.c_str (), SFM_READ, &info);
@@ -244,8 +245,8 @@
 #endif
 
 DEFUN_DLD (audiowrite, args, ,
-  "-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs})\n\
+           "-*- texinfo -*-\n\
+@deftypefn  {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs})\n\
 @deftypefnx {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs}, @var{name}, @var{value}, @dots{})\n\
 \n\
 Write audio data from the matrix @var{y} to @var{filename} with the file\n\
@@ -256,15 +257,21 @@
 \n\
 @table @samp\n\
 @item BitsPerSample\n\
-Number of bits per sample, valid values are 8, 16, 24 and 32. Default is 16.\n\
+Number of bits per sample, valid values are 8, 16, 24 and 32.  Default is 16.\n\
+\n\
 @item BitRate\n\
-Valid argument name, but ignored. Left for compatibility with @sc{matlab}.\n\
+Valid argument name, but ignored.  Left for compatibility with @sc{matlab}.\n\
+\n\
 @item Quality\n\
-Quality setting for the Ogg Vorbis compressor. Values can range between 0 and 100 with 100 being the highest quality setting. Default is 75.\n\
+Quality setting for the Ogg Vorbis compressor.  Values can range between 0\n\
+and 100 with 100 being the highest quality setting.  Default is 75.\n\
+\n\
 @item Title\n\
 Title for the audio file.\n\
+\n\
 @item Artist\n\
 Artist name.\n\
+\n\
 @item Comment\n\
 Comment.\n\
 @end table\n\
@@ -437,7 +444,7 @@
 }
 
 DEFUN_DLD (audioinfo, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{info} =} audioinfo (@var{filename})\n\
 Return information about an audio file specified by @var{filename}.\n\
 @end deftypefn")