Mercurial > hg > octave-nkf
diff scripts/image/contrast.m @ 14260:1f911333ed3d
doc: Update docstrings for functions in image/ directory
* aspell-octave.en.pws, brighten.m, colormap.m, contrast.m, flag.m, gmap40.m
gray.m, gray2ind.m, hsv2rgb.m, image.m, ind2gray.m, ind2rgb.m, ntsc2rgb.m,
ocean.m, rgb2hsv.m, rgb2ind.m, rgb2ntsc.m: Update docstrings.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Tue, 24 Jan 2012 09:51:48 -0800 |
| parents | f9bd63f5ddd0 |
| children | 806ea52af230 |
line wrap: on
line diff
--- a/scripts/image/contrast.m +++ b/scripts/image/contrast.m @@ -17,12 +17,12 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} contrast (@var{x}) -## @deftypefnx {Function File} {} contrast (@var{x}, @var{n}) +## @deftypefn {Function File} {@var{map} =} contrast (@var{x}) +## @deftypefnx {Function File} {@var{map} =} contrast (@var{x}, @var{n}) ## Return a gray colormap that maximizes the contrast in an image. The ## returned colormap will have @var{n} rows. If @var{n} is not defined ## then the size of the current colormap is used. -## @seealso{colormap} +## @seealso{colormap, brighten} ## @end deftypefn function map = contrast (x, n)