Mercurial > octave

diff scripts/audio/@audiorecorder/set.m @ 30561:1c6e04afe50d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: improvements to documentation for classes in scripts/ dir. * +containers/Map.m (remove): Document calling form which returns a Map object. * @ftp/cd.m: Document calling forms which return CWD. * @ftp/dir.m: Document calling form which returns struct array. * @ftp/mput.m: Document calling form which returns cellstr. * @ftp/rename.m: Use @code{} macro around "ftp" for conformity with other functions. * @audioplayer/__get_properties__.m: Match documentation variable names to function prototype names. * @audioplayer/set.m: Match function prototype names to documentation. * @audiorecorder/__get_properties__.m: Match documentation variable names to function prototype names. * @audiorecorder/set.m: Match function prototype names to documentation.
author Rik <rik@octave.org>
date Tue, 28 Dec 2021 08:11:59 -0800
parents 0a5b15007766
children 83f9f8bda883
line wrap: on
line diff
--- a/scripts/audio/@audiorecorder/set.m	Mon Dec 27 20:04:52 2021 -0800
+++ b/scripts/audio/@audiorecorder/set.m	Tue Dec 28 08:11:59 2021 -0800
@@ -33,10 +33,10 @@
 ## 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 only the recorder object, return a
-## structure of settable properties.
+## configurable properties (i.e., writeable properties).
 ## @end deftypefn
 
-function settable = set (varargin)
+function properties = set (varargin)
 
   if (nargin < 1 || nargin > 3)
     print_usage ();
@@ -45,9 +45,9 @@
   recorder = struct (varargin{1}).recorder;
 
   if (nargin == 1)
-    settable.SampleRate = {};
-    settable.Tag = {};
-    settable.UserData = {};
+    properties.SampleRate = {};
+    properties.Tag = {};
+    properties.UserData = {};
   elseif (nargin == 2)
     for [value, property] = varargin{2}
       setproperty (recorder, property, value);