view scripts/audio/@audiorecorder/get.m @ 19539:ce02743b6f2a

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 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{recorder}, @var{name})
## Returns the @var{value} of the property identified by @var{name}.
## @end deftypefn
## @deftypefn {Function File} {@var{values} =} get (@var{recorder}, @{@var{name1}, @dots{}, @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{recorder})
## Returns a scalar structure with values of all properties of @var{recorder}.
## 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