Mercurial > octave-nkf
changeset 17717:76f448d8089d
doc: minor cleanup of fftfilt docstring
* scripts/signal/fftfilt.m: Add @deftypefnx to show alternate calling
forms. Delete accidental @var from N indicating the FFT size. Delete
stray punctuation.
| author | Mike Miller <mtmiller@ieee.org> |
|---|---|
| date | Mon, 21 Oct 2013 18:51:21 -0400 |
| parents | e48f5a52e838 |
| children | 6ed0a8532bcf |
| files | scripts/signal/fftfilt.m |
| diffstat | 1 files changed, 4 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/signal/fftfilt.m Fri Dec 07 10:03:33 2012 -0500 +++ b/scripts/signal/fftfilt.m Mon Oct 21 18:51:21 2013 -0400 @@ -17,14 +17,15 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} fftfilt (@var{b}, @var{x}, @var{n}) +## @deftypefn {Function File} {} fftfilt (@var{b}, @var{x}) +## @deftypefnx {Function File} {} fftfilt (@var{b}, @var{x}, @var{n}) ## ## With two arguments, @code{fftfilt} filters @var{x} with the FIR filter ## @var{b} using the FFT. ## ## Given the optional third argument, @var{n}, @code{fftfilt} uses the -## overlap-add method to filter @var{x} with @var{b} using an @var{n}-point -## FFT@. The FFT size must be an even power of 2 and must be greater than +## overlap-add method to filter @var{x} with @var{b} using an N-point +## FFT. The FFT size must be an even power of 2 and must be greater than ## or equal to the length of @var{b}. If the specified @var{n} does not ## meet these criteria, it is automatically adjusted to the nearest value ## that does.