comparison scripts/audio/@audioplayer/get.m @ 19605:72304a4e010a

Use Octave coding conventions for documentation of audio functions. * audio.txi, audioread.cc, @audioplayer/audioplayer.m, @audioplayer/get.m, @audioplayer/play.m, @audioplayer/playblocking.m, @audioplayer/set.m, @audiorecorder/audiorecorder.m, @audiorecorder/get.m, @audiorecorder/getaudiodata.m, @audiorecorder/play.m, @audiorecorder/record.m, @audiorecorder/set.m: Use Octave documentation standards. * audiodevinfo.cc: Limit lines to 80 chars. Indent according to GNU style.
author Rik <rik@octave.org>
date Tue, 13 Jan 2015 08:54:25 -0800
parents 5802ea7037d4
children 4197fc428c7d
comparison
equal deleted inserted replaced
19604:62ca016dbb2a 19605:72304a4e010a
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{player}, @var{name}) 20 ## @deftypefn {Function File} {@var{value} =} get (@var{player}, @var{name})
21 ## @deftypefnx {Function File} {@var{values} =} get (@var{player}) 21 ## @deftypefnx {Function File} {@var{values} =} get (@var{player})
22 ## Return the @var{value} of the property identified by @var{name}. 22 ## Return the @var{value} of the property identified by @var{name}.
23 ## If @var{name} is a cell array return the values of of the properties 23 ## If @var{name} is a cell array return the values of the properties
24 ## identified by the elements of the cell array. Given only the 24 ## identified by the elements of the cell array. Given only the
25 ## player object, return a scalar structure with values of all 25 ## player object, return a scalar structure with values of all
26 ## properties of @var{player}. The field names of the structure 26 ## properties of @var{player}. The field names of the structure
27 ## correspond to property names. 27 ## correspond to property names.
28 ## @end deftypefn 28 ## @end deftypefn