Mercurial > hg > octave-lyh
changeset 17377:3e95b22f5287
doc: Remove private functions from signal documentation chapter (bug #39939).
* doc/interpreter/signal.txi: Remove @DOCSTRING macros for triangle_sw,
triangle_lw, rectangle_sw, rectangle_lw. Re-order @DOCSTRING macros
to place all fft/ifft functions together. Remove excess newlines.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 04 Sep 2013 08:20:25 -0700 |
parents | ddc85ecc901f |
children | c7c0dad2f9ac |
files | doc/interpreter/signal.txi |
diffstat | 1 files changed, 14 insertions(+), 24 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/signal.txi +++ b/doc/interpreter/signal.txi @@ -19,18 +19,23 @@ @node Signal Processing @chapter Signal Processing - This chapter describes the signal processing and fast Fourier transform functions available in Octave. Fast Fourier transforms are computed with the @sc{fftw} or @sc{fftpack} libraries depending on how Octave is built. - - - -@DOCSTRING(detrend) @DOCSTRING(fft) +@DOCSTRING(ifft) + +@DOCSTRING(fft2) + +@DOCSTRING(ifft2) + +@DOCSTRING(fftn) + +@DOCSTRING(ifftn) + Octave uses the @sc{fftw} libraries to perform FFT computations. When Octave starts up and initializes the @sc{fftw} libraries, they read a system wide file (on a Unix system, it is typically @file{/etc/fftw/wisdom}) that @@ -45,16 +50,6 @@ @DOCSTRING(fftw) -@DOCSTRING(ifft) - -@DOCSTRING(fft2) - -@DOCSTRING(ifft2) - -@DOCSTRING(fftn) - -@DOCSTRING(ifftn) - @DOCSTRING(fftconv) @DOCSTRING(fftfilt) @@ -71,7 +66,7 @@ @DOCSTRING(unwrap) -@c FIXME -- someone needs to organize these... +@c FIXME: someone needs to organize these ... @DOCSTRING(arch_fit) @@ -87,6 +82,8 @@ @DOCSTRING(blackman) +@DOCSTRING(detrend) + @DOCSTRING(diffpara) @DOCSTRING(durbinlevinson) @@ -107,10 +104,6 @@ @DOCSTRING(periodogram) -@DOCSTRING(rectangle_lw) - -@DOCSTRING(rectangle_sw) - @DOCSTRING(sinetone) @DOCSTRING(sinewave) @@ -125,8 +118,5 @@ @DOCSTRING(synthesis) -@DOCSTRING(triangle_lw) +@DOCSTRING(yulewalker) -@DOCSTRING(triangle_sw) - -@DOCSTRING(yulewalker)