Mercurial > octave-nkf

diff scripts/audio/@audioplayer/set.m @ 19539: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 fdb8a62ef17a
line wrap: on
line diff
--- a/scripts/audio/@audioplayer/set.m	Thu Oct 03 08:33:46 2013 -0400
+++ b/scripts/audio/@audioplayer/set.m	Thu Oct 03 09:50:01 2013 -0400
@@ -17,16 +17,19 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn{Function File} set (@var{playerObj}, @var{Name}, @var{Value})
-## Set the value of property specified by @var{Name} to a given @var{Value}.
+## @deftypefn {Function File} {} set (@var{player}, @var{name}, @var{value})
+## Set the value of property specified by @var{name} to a given @var{value}.
+## @end deftypefn
+## @deftypefn {Function File} {} set (@var{player}, @var{names}, @var{values})
+## Given a cell array of property @var{names} and a cell array of @var{values},
+## set each property to a corresponding value.
 ## @end deftypefn
-## @deftypefn{Function File} set (@var{playerObj}, @var{CellOfNames}, @var{CellOfValues})
-## Given a cell array of property names and a cell array of values, set each property to a corresponding value.
+## @deftypefn {Function File} {} set (@var{player}, @var{properties})
+## Given a structure @var{properties} where fields are property names, set
+## the value of those properties for an audioplayer object to corresponding
+## values.
 ## @end deftypefn
-## @deftypefn{Function File} set (@var{playerObj}, @var{StructOfProperties})
-## Given a structure where fields are property names, set the value of those properties for an audioplayer object to corresponding values.
-## @end deftypefn
-## @deftypefn{Function File} @var{settableProperties} = set (@var{playerObj})
+## @deftypefn {Function File} {@var{properties} =} set (@var{player})
 ## Returns a structure of settable properties.
 ## @end deftypefn