view scripts/audio/@audioplayer/get.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 source

## Copyright (C) 2013 Vytautas JanĨauskas
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {@var{value} =} get (@var{player}, @var{name})
## @deftypefnx {Function File} {@var{values} =} get (@var{player})
## Return the @var{value} of the property identified by @var{name}.
## If @var{name} is a cell array return the values of of the properties
## identified by the elements of the cell array.  Given only the
## player object, return a scalar structure with values of all
## properties of @var{player}.  The field names of the structure
## correspond to property names.
## @end deftypefn

function result = get (varargin)
  player = varargin{1};
  properties = __get_properties__ (player);
  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 ("audioplayer: wrong number of arguments to the get method");
  endif
endfunction