Mercurial > octave-nkf
view scripts/audio/@audiorecorder/get.m @ 19531:77b52b86b419
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 | ee3ec3f02358 |
children | 8bb399569393 |
line wrap: on
line source
## -*- texinfo -*- ## @deftypefn{Function File} @var{Value} = get (@var{recorderObj}, @var{Name}) ## Returns the @var{Value} of the property identified by @var{Name}. ## @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}. ## @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 function result = get (varargin) recorder = varargin{1}; properties = __get_properties__ (recorder); if nargin == 1 result = properties; elseif nargin == 2 if ischar (varargin{2}) result = getfield (properties, varargin{2}); else result = {}; index = 1; for property = varargin{2} result{index} = getfield (properties, char(property)); index = index + 1; endfor endif else error ('audiorecorder: wrong number of arguments to the get method'); endif endfunction