Mercurial > octave-antonio

diff libinterp/dldfcn/audiodevinfo.cc @ 19505:ce02743b6f2a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix texinfo docstring syntax for all audio functions * libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/audiowrite.cc, scripts/audio/@audioplayer/__get_properties__.m, scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/display.m, scripts/audio/@audioplayer/get.m, scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/pause.m, scripts/audio/@audioplayer/play.m, scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/resume.m, scripts/audio/@audioplayer/set.m, scripts/audio/@audioplayer/stop.m, scripts/audio/@audiorecorder/audiorecorder.m, scripts/audio/@audiorecorder/display.m, scripts/audio/@audiorecorder/get.m, scripts/audio/@audiorecorder/getaudiodata.m, scripts/audio/@audiorecorder/getplayer.m, scripts/audio/@audiorecorder/isrecording.m, scripts/audio/@audiorecorder/pause.m, scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m, scripts/audio/@audiorecorder/recordblocking.m, scripts/audio/@audiorecorder/resume.m, scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m: Fix texinfo docstring formatting, wrap long lines, and use consistent lowercase variable names.
author Mike Miller <mtmiller@ieee.org>
date Thu, 03 Oct 2013 09:50:01 -0400
parents 36a26a131209
children 2a16dac2176f
line wrap: on
line diff
--- a/libinterp/dldfcn/audiodevinfo.cc	Thu Oct 03 08:33:46 2013 -0400
+++ b/libinterp/dldfcn/audiodevinfo.cc	Thu Oct 03 09:50:01 2013 -0400
@@ -46,50 +46,48 @@
 }
 
 DEFUN_DLD (audiodevinfo, args, ,
-"-*- texinfo -*-\n\
-@deftypefn{Loadable Function} @var{devinfo} = audiodevinfo\n\
+  "-*- texinfo -*-\n\
+@deftypefn {Loadable Function} {@var{devinfo} =} audiodevinfo ()\n\
 \n\
-Returns a structure with two fields called \"input\" and \"output\". \
-Each structure contains an array of structures with three fields called \
-\"Name\", \"DriverVersion\" and \"ID\". Each structure contains information \
+Returns a structure with two fields called \"input\" and \"output\".\n\
+Each structure contains an array of structures with three fields called\n\
+\"Name\", \"DriverVersion\" and \"ID\". Each structure contains information\n\
 about a PortAudio device.\n\
 \n\
 @end deftypefn\n\
 \n\
-@deftypefn{Loadable Function} @var{devs} = audiodevinfo (@var{IO})\n\
+@deftypefn {Loadable Function} {@var{devs} =} audiodevinfo (@var{io})\n\
 \n\
-Returns the number of input or output devices available. Set @var{IO} to 1 \
+Returns the number of input or output devices available. Set @var{io} to 1\n\
 for input devices and to 0 for output devices.\n\
 @end deftypefn\n\
 \n\
-@deftypefn{Loadable Function} @var{name} = audiodevinfo (@var{IO}, @var{ID})\n\
+@deftypefn {Loadable Function} {@var{name} =} audiodevinfo (@var{io}, @var{id})\n\
 \n\
-Returns the name of a device specified by numerical @var{ID}. Set @var{IO} \
+Returns the name of a device specified by numerical @var{id}. Set @var{io}\n\
 to 1 for input devices and to 0 for output devices.\n\
 @end deftypefn\n\
 \n\
-@deftypefn{Loadable Function} @var{id} = audiodevinfo (@var{IO}, @var{name})\n\
+@deftypefn {Loadable Function} {@var{id} =} audiodevinfo (@var{io}, @var{name})\n\
 \n\
-Returns the id of a device specified by name. Set @var{IO} \
+Returns the id of a device specified by name. Set @var{io}\n\
 to 1 for input devices and to 0 for output devices.\n\
 @end deftypefn\n\
 \n\
-@deftypefn{Loadable Function} @var{id} = audiodevinfo (@var{IO}, @var{rate},\
- @var{bits}, @var{chans})\n\
+@deftypefn {Loadable Function} {@var{id} =} audiodevinfo (@var{io}, @var{rate}, @var{bits}, @var{chans})\n\
 \n\
-Returns the id of the first device that supports playback or recording\
- using the specified sampling rate (@var{rate}), bits per sample (@var{bits})\
- and number of channels (@var{chans}). Set @var{IO} to 1 for input devices\
- ant to 0 for output devices.\
+Returns the id of the first device that supports playback or recording\n\
+using the specified sampling rate (@var{rate}), bits per sample (@var{bits})\n\
+and number of channels (@var{chans}). Set @var{io} to 1 for input devices\n\
+and to 0 for output devices.\n\
 @end deftypefn\n\
 \n\
-@deftypefn{Loadable Function} @var{supports} = audiodevinfo (@var{IO}, @var{ID},\
- @var{rate}, @var{bits}, @var{chans})\n\
+@deftypefn {Loadable Function} {@var{supports} =} audiodevinfo (@var{io}, @var{id}, @var{rate}, @var{bits}, @var{chans})\n\
 \n\
-Returns 1 if the device bearing @var{ID} supports specified sampling rate\
- (@var{rate}), bits per sample (@var{bits}) and number of channels (@var{chans}).\
- Returns 0 otherwise. Set @var{IO} to 1 for input devices and to 0 for output\
- devices.\n\
+Returns 1 if the device bearing @var{id} supports specified sampling rate\n\
+(@var{rate}), bits per sample (@var{bits}) and number of channels (@var{chans}).\n\
+Returns 0 otherwise. Set @var{io} to 1 for input devices and to 0 for output\n\
+devices.\n\
 @end deftypefn")
 {
   octave_value retval;