Mercurial > octave-nkf

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
19538:d7b55fc1b37d 19539:ce02743b6f2a
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn{Function File} @var{Value} = get (@var{recorderObj}, @var{Name}) 20 ## @deftypefn {Function File} {@var{value} =} get (@var{recorder}, @var{name})
21 ## Returns the @var{Value} of the property identified by @var{Name}. 21 ## Returns the @var{value} of the property identified by @var{name}.
22 ## @end deftypefn 22 ## @end deftypefn
23 ## @deftypefn{Function File} @var{Values} = get (@var{recorderObj}, @{@var{Name1}, ... , @var{NameN}@}) 23 ## @deftypefn {Function File} {@var{values} =} get (@var{recorder}, @{@var{name1}, @dots{}, @var{namen}@})
24 ## Returns the @var{Values} of the properties identified by @var{Name1} to @var{NameN}. 24 ## Returns the @var{values} of the properties identified by @var{name1} to
25 ## @var{namen}.
25 ## @end deftypefn 26 ## @end deftypefn
26 ## @deftypefn{Function File} @var{Values} = get (@var{recorderObj}) 27 ## @deftypefn {Function File} {@var{values} =} get (@var{recorder})
27 ## Returns a scalar structure with values of all properties of @var{recorderObj}. 28 ## Returns a scalar structure with values of all properties of @var{recorder}.
28 ## The field names correspond to property names. 29 ## The field names correspond to property names.
29 ## @end deftypefn 30 ## @end deftypefn
30 31
31 function result = get (varargin) 32 function result = get (varargin)
32 recorder = varargin{1}; 33 recorder = varargin{1};