Mercurial > octave
diff scripts/image/brighten.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 | 72c96de7a403 |
| children | 806ea52af230 |
line wrap: on
line diff
--- a/scripts/image/brighten.m Tue Jan 24 08:53:42 2012 -0800 +++ b/scripts/image/brighten.m Tue Jan 24 09:51:48 2012 -0800 @@ -18,20 +18,18 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{map_out} =} brighten (@var{map}, @var{beta}) +## @deftypefnx {Function File} {@var{map_out} =} brighten (@var{beta}) ## @deftypefnx {Function File} {@var{map_out} =} brighten (@var{h}, @var{beta}) -## @deftypefnx {Function File} {@var{map_out} =} brighten (@var{beta}) -## Darken or brighten the given colormap. If the @var{map} argument -## is omitted, the function is applied to the current colormap. The first -## argument can also be a valid graphics handle @var{h}, in which case -## @code{brighten} is applied to the colormap associated with this handle. +## Brighten or darken a colormap. If the @var{map} argument is omitted, the +## function is applied to the current colormap. The first argument can also be +## a valid graphics handle @var{h}, in which case @code{brighten} is applied to +## the colormap associated with this handle. ## -## Should the resulting colormap @var{map_out} not be assigned, it will be -## written to the current colormap. +## The argument @var{beta} must be a scalar between -1 and 1, where a +## negative value darkens and a positive value brightens the colormap. ## -## The argument @var{beta} should be a scalar between -1 and 1, -## where a negative value darkens and a positive value brightens -## the colormap. -## @seealso{colormap} +## If no output is specified then the result is written to the current colormap. +## @seealso{colormap, contrast} ## @end deftypefn function rmap = brighten (arg1, beta)