changeset 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 62ca016dbb2a
children 2aaf6077eb3c
files doc/interpreter/audio.txi libinterp/dldfcn/audiodevinfo.cc libinterp/dldfcn/audioread.cc scripts/audio/@audioplayer/audioplayer.m scripts/audio/@audioplayer/get.m scripts/audio/@audioplayer/play.m scripts/audio/@audioplayer/playblocking.m scripts/audio/@audioplayer/set.m scripts/audio/@audiorecorder/audiorecorder.m scripts/audio/@audiorecorder/get.m scripts/audio/@audiorecorder/getaudiodata.m scripts/audio/@audiorecorder/play.m scripts/audio/@audiorecorder/record.m scripts/audio/@audiorecorder/set.m
diffstat 14 files changed, 90 insertions(+), 78 deletions(-) [+]
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)
--- a/libinterp/dldfcn/audiodevinfo.cc	Tue Jan 13 12:50:43 2015 +0100
+++ b/libinterp/dldfcn/audiodevinfo.cc	Tue Jan 13 08:54:25 2015 -0800
@@ -65,7 +65,7 @@
 #endif
 
 DEFUN_DLD (audiodevinfo, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{devinfo} =} audiodevinfo ()\n\
 \n\
 @deftypefnx {Loadable Function} {@var{devs} =} audiodevinfo (@var{io})\n\
@@ -555,7 +555,7 @@
 
   const ColumnVector sound_l = sound.column (0);
   const ColumnVector sound_r = (sound.columns () == 1)
-    ? sound_l : sound.column (1);
+                               ? sound_l : sound.column (1);
 
   const double *p_l = sound_l.data ();
   const double *p_r = sound_r.data ();
@@ -864,7 +864,8 @@
   output_parameters.device = device;
   output_parameters.channelCount = 2;
   output_parameters.sampleFormat = bits_to_format (get_nbits ());
-  output_parameters.suggestedLatency = Pa_GetDeviceInfo (device)->defaultHighOutputLatency;
+  output_parameters.suggestedLatency = 
+    Pa_GetDeviceInfo (device)->defaultHighOutputLatency;
   output_parameters.hostApiSpecificStreamInfo = 0;
 }
 
@@ -906,7 +907,8 @@
   else if (type == TYPE_UINT16)
     output_parameters.sampleFormat = paInt16;
 
-  output_parameters.suggestedLatency = Pa_GetDeviceInfo (device)->defaultHighOutputLatency;
+  output_parameters.suggestedLatency =
+    Pa_GetDeviceInfo (device)->defaultHighOutputLatency;
   output_parameters.hostApiSpecificStreamInfo = 0;
 }
 
@@ -1079,7 +1081,7 @@
   PaError err;
   uint32_t buffer[BUFFER_SIZE * 2];
   err = Pa_OpenStream (&stream, 0, &(output_parameters), get_fs (),
-                               BUFFER_SIZE, paClipOff, 0, 0);
+                       BUFFER_SIZE, paClipOff, 0, 0);
   if (err != paNoError)
     {
       error ("audioplayer: unable to open audio playback stream");
@@ -1338,7 +1340,7 @@
           sound(i, 0) = sample_l;
           sound(i, 1) = sample_r;
         }
-      }
+    }
   else if (recorder->get_nbits () == 16)
     {
       static double scale_factor = std::pow (2.0, 15) - 1.0;
@@ -1508,7 +1510,8 @@
   input_parameters.device = device;
   input_parameters.channelCount = get_channels ();
   input_parameters.sampleFormat = bits_to_format (get_nbits ());
-  input_parameters.suggestedLatency = Pa_GetDeviceInfo (device)->defaultHighInputLatency;
+  input_parameters.suggestedLatency =
+    Pa_GetDeviceInfo (device)->defaultHighInputLatency;
   input_parameters.hostApiSpecificStreamInfo = 0;
 }
 
@@ -1818,7 +1821,7 @@
 #endif
 
 DEFUN_DLD (__recorder_audiorecorder__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn  {Loadable Function} {@var{recorder} =} __recorder_audiorecorder__ (@var{fs}, @var{nbits}, @var{channels})\n\
 @deftypefnx {Loadable Function} {@var{recorder} =} __recorder_audiorecorder__ (@var{fs}, @var{nbits}, @var{channels}, @var{id})\n\
 @deftypefnx {Loadable Function} {@var{recorder} =} __recorder_audiorecorder__ (@var{fcn}, @dots{})\n\
@@ -1837,7 +1840,8 @@
 
   if (nargin > 0)
     {
-      bool is_function = args(0).is_string () || args(0).is_function_handle () || args(0).is_inline_function ();
+      bool is_function = args(0).is_string () || args(0).is_function_handle ()
+                         || args(0).is_inline_function ();
 
       if (is_function)
         {
@@ -1893,7 +1897,7 @@
 #endif
 
 DEFUN_DLD (__recorder_getaudiodata__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{data}} __recorder_getaudiodata__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -1915,7 +1919,7 @@
 }
 
 DEFUN_DLD (__recorder_get_channels__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{n} =} __recorder_get_channels__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -1940,7 +1944,7 @@
 }
 
 DEFUN_DLD (__recorder_get_fs__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{fs} =} __recorder_get_fs__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -1965,7 +1969,7 @@
 }
 
 DEFUN_DLD (__recorder_get_id__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{id} =} __recorder_get_id__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -1990,7 +1994,7 @@
 }
 
 DEFUN_DLD (__recorder_get_nbits__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{nbits} =} __recorder_get_nbits__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2015,7 +2019,7 @@
 }
 
 DEFUN_DLD (__recorder_get_sample_number__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{n} =} __recorder_get_sample_number__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2040,7 +2044,7 @@
 }
 
 DEFUN_DLD (__recorder_get_tag__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{tag} =} __recorder_get_tag__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2065,7 +2069,7 @@
 }
 
 DEFUN_DLD (__recorder_get_total_samples__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{n} =} __recorder_get_total_samples__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2090,7 +2094,7 @@
 }
 
 DEFUN_DLD (__recorder_get_userdata__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{data} =} __recorder_get_userdata__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2115,7 +2119,7 @@
 }
 
 DEFUN_DLD (__recorder_isrecording__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __recorder_isrecording__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2140,7 +2144,7 @@
 }
 
 DEFUN_DLD (__recorder_pause__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __recorder_pause__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2165,7 +2169,7 @@
 }
 
 DEFUN_DLD (__recorder_recordblocking__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __recorder_recordblocking__ (@var{recorder}, @var{seconds})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2187,7 +2191,7 @@
 }
 
 DEFUN_DLD (__recorder_record__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn  {Loadable Function} {} __recorder_record__ (@var{recorder})\n\
 @deftypefnx {Loadable Function} {} __recorder_record__ (@var{recorder}, @var{seconds})\n\
 Undocumented internal function.\n\
@@ -2219,7 +2223,7 @@
 }
 
 DEFUN_DLD (__recorder_resume__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __recorder_resume__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2244,7 +2248,7 @@
 }
 
 DEFUN_DLD (__recorder_set_fs__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __recorder_set_fs__ (@var{recorder}, @var{fs})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2269,7 +2273,7 @@
 }
 
 DEFUN_DLD (__recorder_set_tag__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __recorder_set_tag__ (@var{recorder}, @var{tag})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2294,7 +2298,7 @@
 }
 
 DEFUN_DLD (__recorder_set_userdata__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __recorder_set_userdata__ (@var{recorder}, @var{data})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2319,7 +2323,7 @@
 }
 
 DEFUN_DLD (__recorder_stop__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __recorder_stop__ (@var{recorder})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2341,7 +2345,7 @@
 }
 
 DEFUN_DLD (__player_audioplayer__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn  {Loadable Function} {@var{player} =} __player_audioplayer__ (@var{y}, @var{fs})\n\
 @deftypefnx {Loadable Function} {@var{player} =} __player_audioplayer__ (@var{y}, @var{fs}, @var{nbits})\n\
 @deftypefnx {Loadable Function} {@var{player} =} __player_audioplayer__ (@var{y}, @var{fs}, @var{nbits}, @var{id})\n\
@@ -2362,7 +2366,8 @@
 
   audioplayer* recorder = new audioplayer ();
 
-  bool is_function = args(0).is_string () || args(0).is_function_handle () || args(0).is_inline_function ();
+  bool is_function = args(0).is_string () || args(0).is_function_handle ()
+                     || args(0).is_inline_function ();
 
   if (is_function)
     {
@@ -2419,7 +2424,7 @@
 #endif
 
 DEFUN_DLD (__player_get_channels__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{n} =} __player_get_channels__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2444,7 +2449,7 @@
 }
 
 DEFUN_DLD (__player_get_fs__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{fs} =} __player_get_fs__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2469,7 +2474,7 @@
 }
 
 DEFUN_DLD (__player_get_id__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{id} =} __player_get_id__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2494,7 +2499,7 @@
 }
 
 DEFUN_DLD (__player_get_nbits__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{nbits} =} __player_get_nbits__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2519,7 +2524,7 @@
 }
 
 DEFUN_DLD (__player_get_sample_number__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{n} =} __player_get_sample_number__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2544,7 +2549,7 @@
 }
 
 DEFUN_DLD (__player_get_tag__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{tag} =} __player_get_tag__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2569,7 +2574,7 @@
 }
 
 DEFUN_DLD (__player_get_total_samples__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{n} =} __player_get_total_samples__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2594,7 +2599,7 @@
 }
 
 DEFUN_DLD (__player_get_userdata__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{data} =} __player_get_userdata__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2619,7 +2624,7 @@
 }
 
 DEFUN_DLD (__player_isplaying__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __player_isplaying__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2644,7 +2649,7 @@
 }
 
 DEFUN_DLD (__player_pause__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __player_pause__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2669,7 +2674,7 @@
 }
 
 DEFUN_DLD (__player_playblocking__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn  {Loadable Function} {} __player_playblocking__ (@var{player})\n\
 @deftypefnx {Loadable Function} {} __player_playblocking__ (@var{player}, @var{start})\n\
 @deftypefnx {Loadable Function} {} __player_playblocking__ (@var{player}, [@var{start}, @var{end}])\n\
@@ -2731,7 +2736,7 @@
 }
 
 DEFUN_DLD (__player_play__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn  {Loadable Function} {} __player_play__ (@var{player})\n\
 @deftypefnx {Loadable Function} {} __player_play__ (@var{player}, @var{start})\n\
 @deftypefnx {Loadable Function} {} __player_play__ (@var{player}, [@var{start}, @var{end}])\n\
@@ -2794,7 +2799,7 @@
 }
 
 DEFUN_DLD (__player_resume__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __player_resume__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2819,7 +2824,7 @@
 }
 
 DEFUN_DLD (__player_set_fs__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __player_set_fs__ (@var{player}, @var{fs})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2844,7 +2849,7 @@
 }
 
 DEFUN_DLD (__player_set_tag__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __player_set_tag__ (@var{player}, @var{tag})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2869,7 +2874,7 @@
 }
 
 DEFUN_DLD (__player_set_userdata__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __player_set_userdata__ (@var{player}, @var{data})\n\
 Undocumented internal function.\n\
 @end deftypefn")
@@ -2894,7 +2899,7 @@
 }
 
 DEFUN_DLD (__player_stop__, args, ,
-  "-*- texinfo -*-\n\
+           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} __player_stop__ (@var{player})\n\
 Undocumented internal function.\n\
 @end deftypefn")
--- 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")
--- a/scripts/audio/@audioplayer/audioplayer.m	Tue Jan 13 12:50:43 2015 +0100
+++ b/scripts/audio/@audioplayer/audioplayer.m	Tue Jan 13 08:54:25 2015 -0800
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{player} =} audioplayer (@var{y}, @var{fs})
+## @deftypefn  {Function File} {@var{player} =} audioplayer (@var{y}, @var{fs})
 ## @deftypefnx {Function File} {@var{player} =} audioplayer (@var{y}, @var{fs}, @var{nbits})
 ## @deftypefnx {Function File} {@var{player} =} audioplayer (@var{y}, @var{fs}, @var{nbits}, @var{id})
 ## @deftypefnx {Function File} {@var{player} =} audioplayer (@var{recorder})
@@ -28,9 +28,8 @@
 ## may be found using the audiodevinfo function.
 ## Given an audioplayer object, use the data from the object to
 ## initialize the player.
-## @end deftypefn
 ##
-## The signal @var{y} can be a vector or a two dimensional array.
+## The signal @var{y} can be a vector or a two-dimensional array.
 ##
 ## The following example will create an audioplayer object that will play
 ## back one second of white noise at 44100 sample rate using 8 bits per
@@ -43,6 +42,7 @@
 ## play (player);
 ## @end group
 ## @end example
+## @end deftypefn
 
 ## FIXME: callbacks don't work properly, apparently because portaudio
 ## will execute the callbacks in a separate thread, and calling Octave
--- a/scripts/audio/@audioplayer/get.m	Tue Jan 13 12:50:43 2015 +0100
+++ b/scripts/audio/@audioplayer/get.m	Tue Jan 13 08:54:25 2015 -0800
@@ -17,10 +17,10 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{value} =} get (@var{player}, @var{name})
+## @deftypefn  {Function File} {@var{value} =} get (@var{player}, @var{name})
 ## @deftypefnx {Function File} {@var{values} =} get (@var{player})
 ## Return the @var{value} of the property identified by @var{name}.
-## If @var{name} is a cell array return the values of of the properties
+## If @var{name} is a cell array return the values of the properties
 ## identified by the elements of the cell array.  Given only the
 ## player object, return a scalar structure with values of all
 ## properties of @var{player}.  The field names of the structure
--- a/scripts/audio/@audioplayer/play.m	Tue Jan 13 12:50:43 2015 +0100
+++ b/scripts/audio/@audioplayer/play.m	Tue Jan 13 08:54:25 2015 -0800
@@ -17,8 +17,8 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} play (@var{player})
-## @deftypefnx {Function File} {} play  (@var{player}, @var{start})
+## @deftypefn  {Function File} {} play (@var{player})
+## @deftypefnx {Function File} {} play (@var{player}, @var{start})
 ## @deftypefnx {Function File} {} play (@var{player}, @var{limits})
 ## Play audio stored in the audioplayer object @var{player} without blocking.
 ## Given optional argument start, begin playing at @var{start} seconds
--- a/scripts/audio/@audioplayer/playblocking.m	Tue Jan 13 12:50:43 2015 +0100
+++ b/scripts/audio/@audioplayer/playblocking.m	Tue Jan 13 08:54:25 2015 -0800
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} playblocking (@var{player})
+## @deftypefn  {Function File} {} playblocking (@var{player})
 ## @deftypefnx {Function File} {} playblocking (@var{player}, @var{start})
 ## @deftypefnx {Function File} {} playblocking (@var{player}, @var{limits})
 ## Play audio stored in the audioplayer object @var{player} with blocking.
--- a/scripts/audio/@audioplayer/set.m	Tue Jan 13 12:50:43 2015 +0100
+++ b/scripts/audio/@audioplayer/set.m	Tue Jan 13 08:54:25 2015 -0800
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} set (@var{player}, @var{name}, @var{value})
+## @deftypefn  {Function File} {} set (@var{player}, @var{name}, @var{value})
 ## @deftypefnx {Function File} {} set (@var{player}, @var{properties})
 ## @deftypefnx {Function File} {@var{properties} =} set (@var{player})
 ## Set the value of property specified by @var{name} to a given @var{value}.
--- a/scripts/audio/@audiorecorder/audiorecorder.m	Tue Jan 13 12:50:43 2015 +0100
+++ b/scripts/audio/@audiorecorder/audiorecorder.m	Tue Jan 13 08:54:25 2015 -0800
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{recorder} =} audiorecorder ()
+## @deftypefn  {Function File} {@var{recorder} =} audiorecorder ()
 ## @deftypefnx {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels})
 ## @deftypefnx {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels}, @var{id})
 ## Create an audiorecorder object recording 8 bit mono audio at 8000 Hz
--- a/scripts/audio/@audiorecorder/get.m	Tue Jan 13 12:50:43 2015 +0100
+++ b/scripts/audio/@audiorecorder/get.m	Tue Jan 13 08:54:25 2015 -0800
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{value} =} get (@var{recorder}, @var{name})
+## @deftypefn  {Function File} {@var{value} =} get (@var{recorder}, @var{name})
 ## @deftypefnx {Function File} {@var{values} =} get (@var{recorder})
 ## Return the @var{value} of the property identified by @var{name}.
 ## If @var{name} is a cell array, return the values of the properties
--- a/scripts/audio/@audiorecorder/getaudiodata.m	Tue Jan 13 12:50:43 2015 +0100
+++ b/scripts/audio/@audiorecorder/getaudiodata.m	Tue Jan 13 08:54:25 2015 -0800
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{data} =} getaudiodata (@var{recorder})
+## @deftypefn  {Function File} {@var{data} =} getaudiodata (@var{recorder})
 ## @deftypefnx {Function File} {@var{data} =} getaudiodata (@var{recorder}, @var{datatype})
 ## Return recorder audio data as a matrix with values between -1.0 and 1.0
 ## and with as many columns as there are channels in the recorder.
--- a/scripts/audio/@audiorecorder/play.m	Tue Jan 13 12:50:43 2015 +0100
+++ b/scripts/audio/@audiorecorder/play.m	Tue Jan 13 08:54:25 2015 -0800
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{player} =} play (@var{recorder})
+## @deftypefn  {Function File} {@var{player} =} play (@var{recorder})
 ## @deftypefnx {Function File} {@var{player} =} play (@var{recorder}, @var{start})
 ## @deftypefnx {Function File} {@var{player} =} play (@var{recorder}, [@var{start}, @var{end}])
 ## Play the audio recorded in @var{recorder} and return a corresponding
--- a/scripts/audio/@audiorecorder/record.m	Tue Jan 13 12:50:43 2015 +0100
+++ b/scripts/audio/@audiorecorder/record.m	Tue Jan 13 08:54:25 2015 -0800
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} record (@var{recorder})
+## @deftypefn  {Function File} {} record (@var{recorder})
 ## @deftypefnx {Function File} {} record (@var{recorder}, @var{length})
 ## Record audio without blocking using the audiorecorder object
 ## @var{recorder} until stopped or paused by the @var{stop} or
--- a/scripts/audio/@audiorecorder/set.m	Tue Jan 13 12:50:43 2015 +0100
+++ b/scripts/audio/@audiorecorder/set.m	Tue Jan 13 08:54:25 2015 -0800
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} set (@var{recorder}, @var{name}, @var{value})
+## @deftypefn  {Function File} {} set (@var{recorder}, @var{name}, @var{value})
 ## @deftypefnx {Function File} {} set (@var{recorder}, @var{properties})
 ## @deftypefnx {Function File} {@var{properties} =} set (@var{recorder})
 ## Set the value of property specified by @var{name} to a given @var{value}.
@@ -25,7 +25,7 @@
 ## set each property to a corresponding value.
 ## Given a structure with fields corresponding to property names, set
 ## the value of those properties to the corresponding field values.
-## Given a only the recorder object, return a structure of settable
+## Given only the recorder object, return a structure of settable
 ## properties.
 ## @end deftypefn