Mercurial > octave-nkf
changeset 19538:d7b55fc1b37d
Add missing texinfo docstrings to all audio functions
* libinterp/dldfcn/__player_audioplayer__.cc,
libinterp/dldfcn/__recorder_audiorecorder__.cc,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/__get_properties__.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m: Add texinfo docstrings to all
functions, internal or otherwise.
| author | Mike Miller <mtmiller@ieee.org> |
|---|---|
| date | Thu, 03 Oct 2013 08:33:46 -0400 |
| parents | 36a26a131209 |
| children | ce02743b6f2a |
| files | libinterp/dldfcn/__player_audioplayer__.cc libinterp/dldfcn/__recorder_audiorecorder__.cc scripts/audio/@audioplayer/subsasgn.m scripts/audio/@audioplayer/subsref.m scripts/audio/@audiorecorder/__get_properties__.m scripts/audio/@audiorecorder/subsasgn.m scripts/audio/@audiorecorder/subsref.m |
| diffstat | 7 files changed, 187 insertions(+), 37 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/dldfcn/__player_audioplayer__.cc Thu Oct 03 07:52:58 2013 -0400 +++ b/libinterp/dldfcn/__player_audioplayer__.cc Thu Oct 03 08:33:46 2013 -0400 @@ -33,7 +33,12 @@ #endif DEFUN_DLD (__player_audioplayer__, args, , -"__player_audioplayer__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{player} =} __player_audioplayer__ (@var{y}, @var{fs})\n\ +@deftypefnx {Loadable Function} {@var{player} =} __player_audioplayer__ (@var{y}, @var{fs}, @var{nbits})\n\ +@deftypefnx {Loadable Function} {@var{player} =} __player_audioplayer__ (@var{y}, @var{fs}, @var{nbits}, @var{id})\n\ +Undocumented internal function.\n\ +@end deftypefn") { #ifdef HAVE_PORTAUDIO int nargin = args.length (); @@ -67,7 +72,10 @@ } DEFUN_DLD (__player_get_channels__, args, , -"__player_get_channels__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{n} =} __player_get_channels__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -85,7 +93,10 @@ } DEFUN_DLD (__player_get_fs__, args, , -"__player_get_fs__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{fs} =} __player_get_fs__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -103,7 +114,10 @@ } DEFUN_DLD (__player_get_id__, args, , -"__player_get_id__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{id} =} __player_get_id__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -121,7 +135,10 @@ } DEFUN_DLD (__player_get_nbits__, args, , -"__player_get_nbits__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{nbits} =} __player_get_nbits__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -139,7 +156,10 @@ } DEFUN_DLD (__player_get_sample_number__, args, , -"__player_get_sample_number__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{n} =} __player_get_sample_number__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -157,7 +177,10 @@ } DEFUN_DLD (__player_get_tag__, args, , -"__player_get_tag__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{tag} =} __player_get_tag__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -175,7 +198,10 @@ } DEFUN_DLD (__player_get_total_samples__, args, , -"__player_get_total_samples__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{n} =} __player_get_total_samples__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -193,7 +219,10 @@ } DEFUN_DLD (__player_get_userdata__, args, , -"__player_get_userdata__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{data} =} __player_get_userdata__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -211,7 +240,10 @@ } DEFUN_DLD (__player_isplaying__, args, , -"__player_isplaying__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __player_isplaying__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -232,7 +264,10 @@ } DEFUN_DLD (__player_pause__, args, , -"__player_pause__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __player_pause__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -250,7 +285,12 @@ } DEFUN_DLD (__player_playblocking__, args, , -"__player_playblocking__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __player_playblocking__ (@var{player})\n\ +@deftypefnx {Loadable Function} {} __player_playblocking__ (@var{player}, @var{start})\n\ +@deftypefnx {Loadable Function} {} __player_playblocking__ (@var{player}, [@var{start}, @var{end}])\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -294,7 +334,12 @@ } DEFUN_DLD (__player_play__, args, , -"__player_play__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __player_play__ (@var{player})\n\ +@deftypefnx {Loadable Function} {} __player_play__ (@var{player}, @var{start})\n\ +@deftypefnx {Loadable Function} {} __player_play__ (@var{player}, [@var{start}, @var{end}])\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -338,7 +383,10 @@ } DEFUN_DLD (__player_resume__, args, , -"__player_resume__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __player_resume__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -356,7 +404,10 @@ } DEFUN_DLD (__player_set_fs__, args, , -"__player_set_fs__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __player_set_fs__ (@var{player}, @var{fs})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -374,7 +425,10 @@ } DEFUN_DLD (__player_set_tag__, args, , -"__player_set_tag__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __player_set_tag__ (@var{player}, @var{tag})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -392,7 +446,10 @@ } DEFUN_DLD (__player_set_userdata__, args, , -"__player_set_userdata__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __player_set_userdata__ (@var{player}, @var{data})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -410,7 +467,10 @@ } DEFUN_DLD (__player_stop__, args, , -"__player_stop__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __player_stop__ (@var{player})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO
--- a/libinterp/dldfcn/__recorder_audiorecorder__.cc Thu Oct 03 07:52:58 2013 -0400 +++ b/libinterp/dldfcn/__recorder_audiorecorder__.cc Thu Oct 03 08:33:46 2013 -0400 @@ -33,7 +33,12 @@ #endif DEFUN_DLD (__recorder_audiorecorder__, args, , -"__recorder_audiorecorder__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{recorder} =} __recorder_audiorecorder__ (@var{fs}, @var{nbits}, @var{channels})\n\ +@deftypefnx {Loadable Function} {@var{recorder} =} __recorder_audiorecorder__ (@var{fs}, @var{nbits}, @var{channels}, @var{id})\n\ +@deftypefnx {Loadable Function} {@var{recorder} =} __recorder_audiorecorder__ (@var{fcn}, @dots{})\n\ +Undocumented internal function.\n\ +@end deftypefn") { #ifdef HAVE_PORTAUDIO int nargin = args.length (); @@ -72,7 +77,10 @@ } DEFUN_DLD (__recorder_getaudiodata__, args, , -"__recorder_getaudiodata__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{data}} __recorder_getaudiodata__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -86,7 +94,10 @@ } DEFUN_DLD (__recorder_get_channels__, args, , -"__recorder_get_channels__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{n} =} __recorder_get_channels__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -104,7 +115,10 @@ } DEFUN_DLD (__recorder_get_fs__, args, , -"__recorder_get_fs__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{fs} =} __recorder_get_fs__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -122,7 +136,10 @@ } DEFUN_DLD (__recorder_get_id__, args, , -"__recorder_get_id__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{id} =} __recorder_get_id__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -140,7 +157,10 @@ } DEFUN_DLD (__recorder_get_nbits__, args, , -"__recorder_get_nbits__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{nbits} =} __recorder_get_nbits__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -158,7 +178,10 @@ } DEFUN_DLD (__recorder_get_sample_number__, args, , -"__recorder_get_sample_number__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{n} =} __recorder_get_sample_number__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -176,7 +199,10 @@ } DEFUN_DLD (__recorder_get_tag__, args, , -"__recorder_get_tag__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{tag} =} __recorder_get_tag__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -194,7 +220,10 @@ } DEFUN_DLD (__recorder_get_total_samples__, args, , -"__recorder_get_total_samples__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{n} =} __recorder_get_total_samples__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -212,7 +241,10 @@ } DEFUN_DLD (__recorder_get_userdata__, args, , -"__recorder_get_userdata__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {@var{data} =} __recorder_get_userdata__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -230,7 +262,10 @@ } DEFUN_DLD (__recorder_isrecording__, args, , -"__recorder_isrecording__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __recorder_isrecording__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -251,7 +286,10 @@ } DEFUN_DLD (__recorder_pause__, args, , -"__recorder_pause__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __recorder_pause__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -269,7 +307,10 @@ } DEFUN_DLD (__recorder_recordblocking__, args, , -"__recorder_recordblocking__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __recorder_recordblocking__ (@var{recorder}, @var{seconds})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -283,7 +324,11 @@ } DEFUN_DLD (__recorder_record__, args, , -"__recorder_record__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __recorder_record__ (@var{recorder})\n\ +@deftypefnx {Loadable Function} {} __recorder_record__ (@var{recorder}, @var{seconds})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -309,7 +354,10 @@ } DEFUN_DLD (__recorder_resume__, args, , -"__recorder_resume__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __recorder_resume__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -327,7 +375,10 @@ } DEFUN_DLD (__recorder_set_fs__, args, , -"__recorder_set_fs__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __recorder_set_fs__ (@var{recorder}, @var{fs})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -345,7 +396,10 @@ } DEFUN_DLD (__recorder_set_tag__, args, , -"__recorder_set_tag__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __recorder_set_tag__ (@var{recorder}, @var{tag})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -363,7 +417,10 @@ } DEFUN_DLD (__recorder_set_userdata__, args, , -"__recorder_set_userdata__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __recorder_set_userdata__ (@var{recorder}, @var{data})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO @@ -381,7 +438,10 @@ } DEFUN_DLD (__recorder_stop__, args, , -"__recorder_stop__") + "-*- texinfo -*-\n\ +@deftypefn {Loadable Function} {} __recorder_stop__ (@var{recorder})\n\ +Undocumented internal function.\n\ +@end deftypefn") { octave_value retval; #ifdef HAVE_PORTAUDIO
--- a/scripts/audio/@audioplayer/subsasgn.m Thu Oct 03 07:52:58 2013 -0400 +++ b/scripts/audio/@audioplayer/subsasgn.m Thu Oct 03 08:33:46 2013 -0400 @@ -16,6 +16,12 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{value} =} subsasgn (@var{player}, @var{idx}, @var{rhs}) +## Perform subscripted assignment on the audio player object @var{player}. +## Assign the value of @var{rhs} to the player property named by @var{idx}. +## @end deftypefn + function value = subsasgn (player, idx, rhs) if (isempty (idx)) error ("audioplayer: missing index");
--- a/scripts/audio/@audioplayer/subsref.m Thu Oct 03 07:52:58 2013 -0400 +++ b/scripts/audio/@audioplayer/subsref.m Thu Oct 03 08:33:46 2013 -0400 @@ -16,6 +16,12 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{value} =} subsref (@var{player}, @var{idx}) +## Perform subscripted selection on the audio player object @var{player}. +## Return the player property value named by @var{idx}. +## @end deftypefn + function value = subsref (player, idx) if (isempty (idx)) error ("audioplayer: missing index");
--- a/scripts/audio/@audiorecorder/__get_properties__.m Thu Oct 03 07:52:58 2013 -0400 +++ b/scripts/audio/@audiorecorder/__get_properties__.m Thu Oct 03 08:33:46 2013 -0400 @@ -16,6 +16,12 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{properties} =} __get_properties__ (@var{recorder}) +## Return a struct containing all named properties of the recorder object +## @var{recorder}. +## @end deftypefn + function properties = __get_properties__ (recorder) properties.BitsPerSample = __recorder_get_nbits__ (struct (recorder).recorder); properties.CurrentSample = __recorder_get_sample_number__ (struct (recorder).recorder);
--- a/scripts/audio/@audiorecorder/subsasgn.m Thu Oct 03 07:52:58 2013 -0400 +++ b/scripts/audio/@audiorecorder/subsasgn.m Thu Oct 03 08:33:46 2013 -0400 @@ -16,6 +16,12 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{value} =} subsasgn (@var{recorder}, @var{idx}, @var{rhs}) +## Perform subscripted assignment on the audio recorder object @var{recorder}. +## Assign the value of @var{rhs} to the recorder property named by @var{idx}. +## @end deftypefn + function value = subsasgn (recorder, idx, rhs) if (isempty (idx)) error ("audiorecorder: missing index");
--- a/scripts/audio/@audiorecorder/subsref.m Thu Oct 03 07:52:58 2013 -0400 +++ b/scripts/audio/@audiorecorder/subsref.m Thu Oct 03 08:33:46 2013 -0400 @@ -16,6 +16,12 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. +## -*- texinfo -*- +## @deftypefn {Function File} {@var{value} =} subsref (@var{recorder}, @var{idx}) +## Perform subscripted selection on the audio recorder object @var{recorder}. +## Return the recorder property value named by @var{idx}. +## @end deftypefn + function value = subsref (recorder, idx) if (isempty (idx)) error ("audiorecorder: missing index");