Mercurial > octave-nkf

changeset 19531:77b52b86b419

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
change @audiorecorder method docstrings to work with new texinfo * audiorecorder.m, get.m, getaudiodata.m, play.m, record.m, set.m: change stand-alone deftypefnx tags to deftypefn tags
author Vytautas Jančauskas <unaudio@gmail.com>
date Fri, 20 Sep 2013 00:51:21 +0300
parents a9c67ed90fc0
children 0ac6a4e7369b
files 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 6 files changed, 28 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/audio/@audiorecorder/audiorecorder.m	Fri Sep 20 00:46:16 2013 +0300
+++ b/scripts/audio/@audiorecorder/audiorecorder.m	Fri Sep 20 00:51:21 2013 +0300
@@ -1,15 +1,20 @@
 ## -*- texinfo -*-
 ## @deftypefn{Function File} recorder = audiorecorder
 ## Create an audiorecorder object recording 8 bit mono audio at 8000 Hz sample rate.
-## @deftypefnx{Function File} recorder = audiorecorder (@var{Fs}, @var{nBytes}, @var{Channels})
+## @end deftypefn
+## @deftypefn{Function File} recorder = audiorecorder (@var{Fs}, @var{nBytes}, @var{Channels})
 ## Create an audiorecorder object recording at specified sample rate @var{Fs}, specified bit depth @var{nBytes} and specified number of @var{Channels}.
-## @deftypefnx{Function File} recorder = audiorecorder (@var{Fs}, @var{nBytes}, @var{Channels}, @var{ID})
+## @end deftypefn
+## @deftypefn{Function File} recorder = audiorecorder (@var{Fs}, @var{nBytes}, @var{Channels}, @var{ID})
 ## Create an audiorecorder object recording at specified sample rate @var{Fs}, specified bit depth @var{nBytes}, number of @var{Channels} and recording on the device specified by @var{ID}. You can get device IDs by using the audiodevinfo function.
-## @deftypefnx{Function File} recorder = audiorecorder (@var{function}, @var{Fs})
+## @end deftypefn
+## @deftypefn{Function File} recorder = audiorecorder (@var{function}, @var{Fs})
 ## Argument @var{function} is a function handle, inline function or a string value of a function name that will get called to process audio. Audio will be recorded at @var{Fs} sampling rate.
-## @deftypefnx{Function File} recorder = audiorecorder (@var{function}, @var{Fs}, @var{nBytes})
+## @end deftypefn
+## @deftypefn{Function File} recorder = audiorecorder (@var{function}, @var{Fs}, @var{nBytes})
 ## Same as above but also allows you to specify the number of bytes per sample.
-## @deftypefnx{Function File} recorder = audiorecorder (@var{function}, @var{Fs}, @var{nBytes}, @var{ID})
+## @end deftypefn
+## @deftypefn{Function File} recorder = audiorecorder (@var{function}, @var{Fs}, @var{nBytes}, @var{ID})
 ## Same as above but also allows you to specify device ID that will be used.
 ## @end deftypefn
 
--- a/scripts/audio/@audiorecorder/get.m	Fri Sep 20 00:46:16 2013 +0300
+++ b/scripts/audio/@audiorecorder/get.m	Fri Sep 20 00:51:21 2013 +0300
@@ -1,9 +1,11 @@
 ## -*- texinfo -*-
 ## @deftypefn{Function File} @var{Value} = get (@var{recorderObj}, @var{Name})
 ## Returns the @var{Value} of the property identified by @var{Name}.
-## @deftypefnx{Function File} @var{Values} = get (@var{recorderObj}, @{@var{Name1}, ... , @var{NameN}@})
+## @end deftypefn
+## @deftypefn{Function File} @var{Values} = get (@var{recorderObj}, @{@var{Name1}, ... , @var{NameN}@})
 ## Returns the @var{Values} of the properties identified by @var{Name1} to @var{NameN}.
-## @deftypefnx{Function File} @var{Values} = get (@var{recorderObj})
+## @end deftypefn
+## @deftypefn{Function File} @var{Values} = get (@var{recorderObj})
 ## Returns a scalar structure with values of all properties of @var{recorderObj}. 
 ## The field names correspond to property names.
 ## @end deftypefn
--- a/scripts/audio/@audiorecorder/getaudiodata.m	Fri Sep 20 00:46:16 2013 +0300
+++ b/scripts/audio/@audiorecorder/getaudiodata.m	Fri Sep 20 00:51:21 2013 +0300
@@ -1,7 +1,8 @@
 ## -*- texinfo -*-
 ## @deftypefn{Function File} getaudiodata (@var{recorderObj})
 ## Returns 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.
-## @deftypefnx{Function File} getaudiodata (@var{recorderObj}, @var{dataType})
+## @end deftypefn
+## @deftypefn{Function File} getaudiodata (@var{recorderObj}, @var{dataType})
 ## Converts recorded data to specified @var{dataType}. It can be set to 'double',
 ## 'single', 'int16', 'int8' or 'uint8'.
 ## @end deftypefn
--- a/scripts/audio/@audiorecorder/play.m	Fri Sep 20 00:46:16 2013 +0300
+++ b/scripts/audio/@audiorecorder/play.m	Fri Sep 20 00:51:21 2013 +0300
@@ -1,9 +1,11 @@
 ## -*- texinfo -*-
 ## @deftypefn{Function File} player = play (@var{recorderObj})
 ## Play the audio recorded in @var{recorderObj} and return a corresponding audioplayer object.
-## @deftypefnx{Function File} player = play (@var{recorderObj}, start)
+## @end deftypefn
+## @deftypefn{Function File} player = play (@var{recorderObj}, start)
 ## Play the audio recorded in @var{recorderObj} starting from @var{start} seconds in to the recording. Returns a corresponding audioplayer object.
-## @deftypefnx{Function File} player = play (@var{recorderObj}, [start, end])
+## @end deftypefn
+## @deftypefn{Function File} player = play (@var{recorderObj}, [start, end])
 ## Play the audio recorded in @var{recorderObj} starting from @var{start} seconds and ending at @var{end} seconds in the recording. Returns a corresponding audioplayer object.
 ## @end deftypefn
 
--- a/scripts/audio/@audiorecorder/record.m	Fri Sep 20 00:46:16 2013 +0300
+++ b/scripts/audio/@audiorecorder/record.m	Fri Sep 20 00:51:21 2013 +0300
@@ -1,7 +1,8 @@
 ## -*- texinfo -*-
 ## @deftypefn{Function File} record (@var{recorderObj})
 ## Record audio without blocking. The recording will continue until you use the stop method on @var{recorderObj}.
-## @deftypefnx{Function File} record (@var{playerObj}, @var{length})
+## @end deftypefn
+## @deftypefn{Function File} record (@var{playerObj}, @var{length})
 ## Record audio without blocking. The recording will continue for @var{length} seconds.
 ## @end deftypefn
 
--- a/scripts/audio/@audiorecorder/set.m	Fri Sep 20 00:46:16 2013 +0300
+++ b/scripts/audio/@audiorecorder/set.m	Fri Sep 20 00:51:21 2013 +0300
@@ -1,11 +1,14 @@
 ## -*- texinfo -*-
 ## @deftypefn{Function File} set (@var{recorderObj}, @var{Name}, @var{Value})
 ## Set the value of property specified by @var{Name} to a given @var{Value}.
-## @deftypefnx{Function File} set (@var{recorderObj}, @var{CellOfNames}, @var{CellOfValues})
+## @end deftypefn
+## @deftypefn{Function File} set (@var{recorderObj}, @var{CellOfNames}, @var{CellOfValues})
 ## Given a cell array of property names and a cell array of values, set each property to a corresponding value.
-## @deftypefnx{Function File} set (@var{recorderObj}, @var{StructOfProperties})
+## @end deftypefn
+## @deftypefn{Function File} set (@var{recorderObj}, @var{StructOfProperties})
 ## Given a structure where fields are property names, set the value of those properties for an audiorecorder object to corresponding values.
-## @deftypefnx{Function File} @var{settableProperties} = set (@var{recorderObj})
+## @end deftypefn
+## @deftypefn{Function File} @var{settableProperties} = set (@var{recorderObj})
 ## Returns a structure of settable properties.
 ## @end deftypefn