Mercurial > octave-nkf

changeset 19532:0ac6a4e7369b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
change docstrings in audio defundld cc files to work with new texinfo * audiodevinfo.cc, audioread.cc, audiowrite.cc: fix stand-alone deftypefnx tags
author Vytautas Jančauskas <unaudio@gmail.com>
date Fri, 20 Sep 2013 01:37:43 +0300
parents 77b52b86b419
children 9c56d3fafb9e
files libinterp/dldfcn/audiodevinfo.cc libinterp/dldfcn/audioread.cc libinterp/dldfcn/audiowrite.cc
diffstat 3 files changed, 23 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/dldfcn/audiodevinfo.cc	Fri Sep 20 00:51:21 2013 +0300
+++ b/libinterp/dldfcn/audiodevinfo.cc	Fri Sep 20 01:37:43 2013 +0300
@@ -39,26 +39,36 @@
 \"Name\", \"DriverVersion\" and \"ID\". Each structure contains information \
 about a PortAudio device.\n\
 \n\
-@deftypefnx{Loadable Function} @var{devs} = audiodevinfo(@var{IO})\n\
+@end deftypefn\n\
+\n\
+@deftypefn{Loadable Function} @var{devs} = audiodevinfo(@var{IO})\n\
 \n\
 Returns the number of input or output devices available. Set @var{IO} to 1 \
 for input devices and to 0 for output devices.\n\
-@deftypefnx{Loadable Function} @var{name} = audiodevinfo(@var{IO}, @var{ID})\n\
+@end deftypefn\n\
+\n\
+@deftypefn{Loadable Function} @var{name} = audiodevinfo(@var{IO}, @var{ID})\n\
 \n\
 Returns the name of a device specified by numerical @var{ID}. Set @var{IO} \
 to 1 for input devices and to 0 for output devices.\n\
-@deftypefnx{Loadable Function} @var{id} = audiodevinfo(@var{IO}, @var{name})\n\
+@end deftypefn\n\
+\n\
+@deftypefn{Loadable Function} @var{id} = audiodevinfo(@var{IO}, @var{name})\n\
 \n\
 Returns the id of a device specified by name. Set @var{IO} \
 to 1 for input devices and to 0 for output devices.\n\
-@deftypefnx{Loadable Function} @var{id} = audiodevinfo(@var{IO}, @var{rate},\
+@end deftypefn\n\
+\n\
+@deftypefn{Loadable Function} @var{id} = audiodevinfo(@var{IO}, @var{rate},\
  @var{bits}, @var{chans})\n\
 \n\
 Returns the id of the first device that supports playback or recording\
  using the specified sampling rate (@var{rate}), bits per sample (@var{bits})\
  and number of channels (@var{chans}). Set @var{IO} to 1 for input devices\
  ant to 0 for output devices.\
-@deftypefnx{Loadable Function} @var{supports} = audiodevinfo(@var{IO}, @var{ID},\
+@end deftypefn\n\
+\n\
+@deftypefn{Loadable Function} @var{supports} = audiodevinfo(@var{IO}, @var{ID},\
  @var{rate}, @var{bits}, @var{chans})\n\
 \n\
 Returns 1 if the device bearing @var{ID} supports specified sampling rate\
--- a/libinterp/dldfcn/audioread.cc	Fri Sep 20 00:51:21 2013 +0300
+++ b/libinterp/dldfcn/audioread.cc	Fri Sep 20 01:37:43 2013 +0300
@@ -12,19 +12,22 @@
 a column matrix with as many rows as there are audio frames and as many columns \
 as there are channels in the file. Sampling rate will be stored in @var{Fs}. \
 \n\
-@deftypefnx{Loadable Function} [@var{y}, @var{Fs}] = audioread(@var{filename}, @var{samples})\n\
+@end deftypefn\n\
+@deftypefn{Loadable Function} [@var{y}, @var{Fs}] = audioread(@var{filename}, @var{samples})\n\
 \n\
 Read a specified range of samples from a file specified by @var{filename}. \
 Argument @var{samples} is a vector with two values specifying starting frame \
 and ending frame. \
 \n\
-@deftypefnx{Loadable Function} [@var{y}, @var{Fs}] = audioread(@var{filename}, @var{dataType})\n\
+@end deftypefn\n\
+@deftypefn{Loadable Function} [@var{y}, @var{Fs}] = audioread(@var{filename}, @var{dataType})\n\
 \n\
 Read a file and return an array of specified type. If @var{dataType} is \"native\" then \
 an array of fixed width integer type will be returned depending on how data is stored \
 in the audio file. If @var{dataType} is \"double\" a double matrix will be returned. \
 \n\
-@deftypefnx{Loadable Function} [@var{y}, @var{Fs}] = audioread(@var{filename}, @var{samples}, @var{dataType})\n\
+@end deftypefn\n\
+@deftypefn{Loadable Function} [@var{y}, @var{Fs}] = audioread(@var{filename}, @var{samples}, @var{dataType})\n\
 \n\
 Read a file and return a specified range of frames in an array of specified type. \
 \n\
--- a/libinterp/dldfcn/audiowrite.cc	Fri Sep 20 00:51:21 2013 +0300
+++ b/libinterp/dldfcn/audiowrite.cc	Fri Sep 20 01:37:43 2013 +0300
@@ -44,7 +44,8 @@
 Write audio data from the matrix @var{y} to a file specified by @var{filename}, \
 file format will be determined by the file extension.\
 \n\
-@deftypefnx{Loadable Function} audiowrite(@var{filename}, @var{y}, @var{Fs}, @var{Name}, @var{Value})\n\
+@end deftypefn\n\
+@deftypefn{Loadable Function} audiowrite(@var{filename}, @var{y}, @var{Fs}, @var{Name}, @var{Value})\n\
 \n\
 Lets you specify additional parameters when writing the file. Those parameters are given in the table below:\n\
 \n\