Mercurial > octave-nkf
diff scripts/image/image_viewer.m @ 10821:693e22af08ae
Grammarcheck documentation of m-files
Add newlines between @item fields for readability.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 26 Jul 2010 21:25:36 -0700 |
parents | d1978e7364ad |
children | a4f482e66b65 |
line wrap: on
line diff
--- a/scripts/image/image_viewer.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/image/image_viewer.m Mon Jul 26 21:25:36 2010 -0700 @@ -35,21 +35,27 @@ ## the filename of the image, and the @code{%f} will (if present) be ## replaced by the zoom factor given to the @code{image} function. ## For example, +## ## @example ## image_viewer ("eog %s"); ## @end example +## ## changes the image viewer to the @code{eog} program. ## ## With two input arguments, images will be displayed by calling ## the function @var{function_handle}. For example, +## ## @example ## image_viewer (data, @@my_image_viewer); ## @end example +## ## sets the image viewer function to @code{my_image_viewer}. The image ## viewer function is called with +## ## @example ## my_image_viewer (@var{x}, @var{y}, @var{im}, @var{zoom}, @var{data}) ## @end example +## ## where @var{x} and @var{y} are the axis of the image, @var{im} is the image ## variable, and @var{data} is extra user-supplied data to be passed to ## the viewer function.