Mercurial > hg > octave-nkf
changeset 19687:9a9b0985e508
audio documentation content and building changes
* Makefile.am: removed audiodevinfo.texi, audioplayer.texi,
audiorecorder.texi and audiofile.texi from the target list
* audio.txi: removed the menu to access the audio documentation files and
removed includes for the audio documentation files
* audioplayer.m: fixed a docstring that was using an un-escaped @ symbol
* module.mk: added @audioplayer and @audioplayer method functions to the
file list
author | Vytautas Jančauskas <unaudio@gmail.com> |
---|---|
date | Thu, 19 Sep 2013 15:13:48 +0300 |
parents | 776787758621 |
children | 93f26237c30b |
files | doc/interpreter/Makefile.am doc/interpreter/audio.txi scripts/audio/@audioplayer/audioplayer.m scripts/audio/module.mk |
diffstat | 4 files changed, 10 insertions(+), 26 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/Makefile.am +++ b/doc/interpreter/Makefile.am @@ -116,10 +116,6 @@ MUNGED_TEXI_SRC = \ arith.texi \ audio.texi \ - audiodevinfo.texi \ - audioplayer.texi \ - audiorecorder.texi \ - audiofile.texi \ basics.texi \ bugs.texi \ container.texi \
--- a/doc/interpreter/audio.txi +++ b/doc/interpreter/audio.txi @@ -21,13 +21,6 @@ @node Audio Processing @chapter Audio Processing -@menu -* Audio Device Information:: -* Audio Player:: -* Audio Recorder:: -* Audio File Utilities:: -@end menu - Octave provides a few functions for dealing with audio data. An audio `sample' is a single output value from an A/D converter, i.e., a small integer number (usually 8 or 16 bits), and audio data is just a series @@ -75,8 +68,3 @@ @DOCSTRING(wavread) @DOCSTRING(wavwrite) - -@include audiodevinfo.texi -@include audioplayer.texi -@include audiorecorder.texi -@include audiofile.texi
--- a/scripts/audio/@audioplayer/audioplayer.m +++ b/scripts/audio/@audioplayer/audioplayer.m @@ -46,7 +46,7 @@ ## @code{ lphase = lphase + nl;} ## @code{ rphase = rphase + nr;} ## @code{endfunction} -## @code{player = audioplayer(@callback_sine, 44100);} +## @code{player = audioplayer(@@callback_sine, 44100);} ## @code{play (player);} ## @code{# play for as long as you want} ## @code{stop (player);}
--- a/scripts/audio/module.mk +++ b/scripts/audio/module.mk @@ -12,13 +12,13 @@ audio/wavwrite.m \ audio/@audioplayer/__get_properties__.m \ audio/@audioplayer/audioplayer.m \ - audio/@audioplayer/display.m \ - audio/@audioplayer/get.m \ - audio/@audioplayer/isplaying.m \ + audio/@audioplayer/display.m \ + audio/@audioplayer/get.m \ + audio/@audioplayer/isplaying.m \ audio/@audioplayer/pause.m \ - audio/@audioplayer/play.m \ - audio/@audioplayer/playblocking.m \ - audio/@audioplayer/resume.m \ + audio/@audioplayer/play.m \ + audio/@audioplayer/playblocking.m \ + audio/@audioplayer/resume.m \ audio/@audioplayer/set.m \ audio/@audioplayer/stop.m \ audio/@audioplayer/subsasgn.m \ @@ -36,9 +36,9 @@ audio/@audiorecorder/recordblocking.m \ audio/@audiorecorder/resume.m \ audio/@audiorecorder/set.m \ - audio/@audiorecorder/stop.m \ - audio/@audiorecorder/subsasgn.m \ - audio/@audiorecorder/susbref.m + audio/@audiorecorder/stop.m \ + audio/@audiorecorder/subsasgn.m \ + audio/@audiorecorder/subsref.m FCN_FILES += $(audio_FCN_FILES)