Mercurial > octave-nkf
diff scripts/audio/@audioplayer/set.m @ 19540:fdb8a62ef17a
fix docstring style in .m files
* @audioplayer/__get_properties__.m, @audioplayer/audioplayer.m,
@audioplayer/get.m, @audioplayer/isplaying.m, @audioplayer/pause.m,
@audioplayer/play.m, @audioplayer/playblocking.m,
@audioplayer/resume.m, @audioplayer/set.m, @audioplayer/stop.m,
@audiorecorder/audiorecorder.m,@audiorecorder/get.m,
@audiorecorder/getaudiodata.m, @audiorecorder/getplayer.m,
@audiorecorder/isrecording.m, @audiorecorder/pause.m,
@audiorecorder/play.m, @audiorecorder/record.m,
@audiorecorder/recordblocking.m, @audiorecorder/resume.m,
@audiorecorder/set.m, @audiorecorder/stop.m: Fix docstring style.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Wed, 31 Dec 2014 13:45:45 -0500 |
| parents | ce02743b6f2a |
| children | dac3191a5301 |
line wrap: on
line diff
--- a/scripts/audio/@audioplayer/set.m Thu Oct 03 09:50:01 2013 -0400 +++ b/scripts/audio/@audioplayer/set.m Wed Dec 31 13:45:45 2014 -0500 @@ -18,19 +18,14 @@ ## -*- texinfo -*- ## @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}. -## @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{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} {@var{properties} =} set (@var{player}) -## Returns a structure of settable properties. +## If @var{name} and @var{value} are cell arrays, set each property to the +## corresponding value. Given a structure of @var{properties} with +## fields corresponding to property names, set the value of those +## properties to the field values. Given only the audioplayer object, +## return a structure of settable properties. ## @end deftypefn function settable = set (varargin)