Mercurial > hg > octave-nkf
changeset 12160:b64b82721062
Make documentation static by removing docstrings depending on #ifdef variables
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 25 Jan 2011 13:07:57 -0800 |
parents | 1f56327759e5 |
children | 1c5ecdda4e9a |
files | src/ChangeLog src/DLD-FUNCTIONS/fft.cc src/DLD-FUNCTIONS/fft2.cc src/DLD-FUNCTIONS/fftn.cc src/load-save.cc |
diffstat | 5 files changed, 51 insertions(+), 66 deletions(-) [+] |
line wrap: on
line diff
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,9 @@ +2011-01-25 Rik <octave@nomad.inbox5.com> + + * DLD-FUNCTIONS/fft.cc, DLD-FUNCTIONS/fft2.cc, DLD-FUNCTIONS/fftn.cc, + load-save.cc: Make docstrings static by removing documentation + depending on #ifdef configuration variables. + 2011-01-25 Konstantinos Poulios <logari81@googlemail.com> * src/graphics.cc (text::properties::update_text_extent):
--- a/src/DLD-FUNCTIONS/fft.cc +++ b/src/DLD-FUNCTIONS/fft.cc @@ -203,9 +203,10 @@ @deftypefn {Loadable Function} {} fft (@var{x})\n\ @deftypefnx {Loadable Function} {} fft (@var{x}, @var{n})\n\ @deftypefnx {Loadable Function} {} fft (@var{x}, @var{n}, @var{dim})\n\ -Compute the FFT of @var{x} using subroutines from\n" -FFTSRC -". The FFT is calculated along the first non-singleton dimension of the\n\ +Compute the discrete Fourier transform of @var{A} using\n\ +a Fast Fourier Transform (FFT) algorithm.\n\ +\n\ +The FFT is calculated along the first non-singleton dimension of the\n\ array. Thus if @var{x} is a matrix, @code{fft (@var{x})} computes the\n\ FFT for each column of @var{x}.\n\ \n\ @@ -231,9 +232,10 @@ @deftypefn {Loadable Function} {} ifft (@var{x})\n\ @deftypefnx {Loadable Function} {} ifft (@var{x}, @var{n})\n\ @deftypefnx {Loadable Function} {} ifft (@var{x}, @var{n}, @var{dim})\n\ -Compute the inverse FFT of @var{x} using subroutines from\n" -FFTSRC -". The inverse FFT is calculated along the first non-singleton dimension\n\ +Compute the inverse discrete Fourier transform of @var{A}\n\ +using a Fast Fourier Transform (FFT) algorithm.\n\ +\n\ +The inverse FFT is calculated along the first non-singleton dimension\n\ of the array. Thus if @var{x} is a matrix, @code{fft (@var{x})} computes\n\ the inverse FFT for each column of @var{x}.\n\ \n\
--- a/src/DLD-FUNCTIONS/fft2.cc +++ b/src/DLD-FUNCTIONS/fft2.cc @@ -171,15 +171,16 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} fft2 (@var{A})\n\ @deftypefnx {Loadable Function} {} fft2 (@var{A}, @var{m}, @var{n})\n\ -Compute the two-dimensional FFT of @var{A} using subroutines from\n" -FFTSRC -". The optional arguments @var{m} and @var{n} may be used specify the\n\ +Compute the two-dimensional discrete Fourier transform of @var{A} using\n\ +a Fast Fourier Transform (FFT) algorithm.\n\ +\n\ +The optional arguments @var{m} and @var{n} may be used specify the\n\ number of rows and columns of @var{A} to use. If either of these is\n\ larger than the size of @var{A}, @var{A} is resized and padded with\n\ zeros.\n\ \n\ If @var{A} is a multi-dimensional matrix, each two-dimensional sub-matrix\n\ -of @var{A} is treated separately\n\ +of @var{A} is treated separately.\n\ @seealso {ifft2, fft, fftn, fftw}\n\ @end deftypefn") { @@ -191,9 +192,10 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} ifft2 (@var{A})\n\ @deftypefnx {Loadable Function} {} ifft2 (@var{A}, @var{m}, @var{n})\n\ -Compute the inverse two-dimensional FFT of @var{A} using subroutines from\n" -FFTSRC -". The optional arguments @var{m} and @var{n} may be used specify the\n\ +Compute the inverse two-dimensional discrete Fourier transform of @var{A}\n\ +using a Fast Fourier Transform (FFT) algorithm.\n\ +\n\ +The optional arguments @var{m} and @var{n} may be used specify the\n\ number of rows and columns of @var{A} to use. If either of these is\n\ larger than the size of @var{A}, @var{A} is resized and padded with\n\ zeros.\n\
--- a/src/DLD-FUNCTIONS/fftn.cc +++ b/src/DLD-FUNCTIONS/fftn.cc @@ -153,13 +153,14 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} fftn (@var{A})\n\ @deftypefnx {Loadable Function} {} fftn (@var{A}, @var{size})\n\ -Compute the N-dimensional FFT of @var{A} using subroutines from\n" -FFTSRC -". The optional vector argument @var{size} may be used specify the\n\ +Compute the N-dimensional discrete Fourier transform of @var{A} using\n\ +a Fast Fourier Transform (FFT) algorithm.\n\ +\n\ +The optional vector argument @var{size} may be used specify the\n\ dimensions of the array to be used. If an element of @var{size} is\n\ -smaller than the corresponding dimension, then the dimension is\n\ -truncated prior to performing the FFT@. Otherwise if an element\n\ -of @var{size} is larger than the corresponding dimension @var{A}\n\ +smaller than the corresponding dimension of @var{A}, then the dimension of\n\ +@var{A} is truncated prior to performing the FFT@. Otherwise, if an element\n\ +of @var{size} is larger than the corresponding dimension then @var{A}\n\ is resized and padded with zeros.\n\ @seealso{ifftn, fft, fft2, fftw}\n\ @end deftypefn") @@ -171,13 +172,14 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} ifftn (@var{A})\n\ @deftypefnx {Loadable Function} {} ifftn (@var{A}, @var{size})\n\ -Compute the inverse N-dimensional FFT of @var{A} using subroutines from\n" -FFTSRC -". The optional vector argument @var{size} may be used specify the\n\ +Compute the inverse N-dimensional discrete Fourier transform of @var{A}\n\ +using a Fast Fourier Transform (FFT) algorithm.\n\ +\n\ +The optional vector argument @var{size} may be used specify the\n\ dimensions of the array to be used. If an element of @var{size} is\n\ -smaller than the corresponding dimension, then the dimension is\n\ -truncated prior to performing the inverse FFT@. Otherwise if an element\n\ -of @var{size} is larger than the corresponding dimension @var{A}\n\ +smaller than the corresponding dimension of @var{A}, then the dimension of\n\ +@var{A} is truncated prior to performing the inverse FFT@. Otherwise, if an\n\ +element of @var{size} is larger than the corresponding dimension then @var{A}\n\ is resized and padded with zeros.\n\ @seealso{fftn, ifft, ifft2, fftw}\n\ @end deftypefn")
--- a/src/load-save.cc +++ b/src/load-save.cc @@ -539,19 +539,6 @@ } -// HDF5 load/save documentation is included in the Octave manual -// regardless, but if HDF5 is not linked in we also include a -// sentence noting this, so the user understands that the features -// aren't available. Define a macro for this sentence: - -#ifdef HAVE_HDF5 -#define HAVE_HDF5_HELP_STRING "" -#else /* ! HAVE_HDF5 */ -#define HAVE_HDF5_HELP_STRING "\n\ -HDF5 load and save are not available, as this Octave executable was\n\ -not linked with the HDF5 library." -#endif /* ! HAVE HDF5 */ - DEFUN (load, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Command} {} load file\n\ @@ -613,14 +600,12 @@ \n\ @item -hdf5\n\ Force Octave to assume the file is in @sc{hdf5} format.\n\ -(HDF5 is a free, portable binary format developed by the National\n\ +(@sc{hdf5} is a free, portable binary format developed by the National\n\ Center for Supercomputing Applications at the University of Illinois.)\n\ Note that Octave can read @sc{hdf5} files not created by itself, but may\n\ -skip some datasets in formats that it cannot support.\n" - -HAVE_HDF5_HELP_STRING - -"\n\ +skip some datasets in formats that it cannot support. This format is\n\ +only available if Octave was built with a link to the @sc{hdf5} libraries.\n\ +\n\ @item -import\n\ This option is accepted for backward compatibility but is ignored.\n\ Octave can now support multi-dimensional HDF data and automatically\n\ @@ -1440,13 +1425,6 @@ } } -#ifdef HAVE_ZLIB -#define HAVE_ZLIB_HELP_STRING "" -#else /* ! HAVE_ZLIB */ -#define HAVE_ZLIB_HELP_STRING "\n\ -This option is not available, as this Octave executable was not linked with\n\ -the zlib library." -#endif /* ! HAVE ZLIB */ DEFUN (save, args, , "-*- texinfo -*-\n\ @@ -1491,11 +1469,10 @@ @item -hdf5\n\ Save the data in @sc{hdf5} format.\n\ (HDF5 is a free, portable binary format developed by the National\n\ -Center for Supercomputing Applications at the University of Illinois.)\n" - -HAVE_HDF5_HELP_STRING - -"\n\ +Center for Supercomputing Applications at the University of Illinois.)\n\ +This format is only available if Octave was built with a link to the\n\ +@sc{hdf5} libraries.\n\ +\n\ @item -float-hdf5\n\ Save the data in @sc{hdf5} format but only using single precision.\n\ Only use this format if you know that all the\n\ @@ -1505,11 +1482,8 @@ @itemx -v7\n\ @itemx -7\n\ @itemx -mat7-binary\n\ -Save the data in @sc{matlab}'s v7 binary data format.\n" - -HAVE_ZLIB_HELP_STRING - -"\n\ +Save the data in @sc{matlab}'s v7 binary data format.\n\ +\n\ @item -V6\n\ @itemx -v6\n\ @itemx -6\n\ @@ -1530,11 +1504,10 @@ @itemx -z\n\ Use the gzip algorithm to compress the file. This works equally on files\n\ that are compressed with gzip outside of octave, and gzip can equally be\n\ -used to convert the files for backward compatibility.\n" - -HAVE_ZLIB_HELP_STRING - -"@end table\n\ +used to convert the files for backward compatibility.\n\ +This option is only available if Octave was built with a link to the zlib\n\ +libraries.\n\ +@end table\n\ \n\ The list of variables to save may use wildcard patterns containing\n\ the following special characters:\n\