Mercurial > hg > octave-terminal
changeset 11101:1f9ab076f5f7
Include the 4 input (color) in the docstrings for mesh() and surf().
author | Ben Abbott <bpabbott@mac.com> |
---|---|
date | Sun, 17 Oct 2010 23:33:55 +0800 |
parents | cdf940db26a0 |
children | eab173e1e80c |
files | scripts/ChangeLog scripts/plot/mesh.m scripts/plot/surf.m |
diffstat | 3 files changed, 24 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,8 @@ +2010-10-17 Ben Abbott <bpabbott@mac.com> + + * plot/mesh.m, plot/surf.m: Include the 4th input (color) in the + docstring. + 2010-10-16 Ben Abbott <bpabbott@mac.com> * plot/private/__errplot__.m, plot/errorbar.m: Allow line and marker
--- a/scripts/plot/mesh.m +++ b/scripts/plot/mesh.m @@ -18,14 +18,22 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} mesh (@var{x}, @var{y}, @var{z}) +## @deftypefn {Function File} {} mesh (@var{x}, @var{y}, @var{z}) +## @deftypefnx {Function File} {} mesh (@var{z}) +## @deftypefnx {Function File} {} mesh (@dots{}, @var{c}) +## @deftypefnx {Function File} {} mesh (@var{hax}, @dots{}) +## @deftypefnx {Function File} {@var{h} = } mesh (@dots{}) ## Plot a mesh given matrices @var{x}, and @var{y} from @code{meshgrid} and ## a matrix @var{z} corresponding to the @var{x} and @var{y} coordinates of ## the mesh. If @var{x} and @var{y} are vectors, then a typical vertex ## is (@var{x}(j), @var{y}(i), @var{z}(i,j)). Thus, columns of @var{z} ## correspond to different @var{x} values and rows of @var{z} correspond ## to different @var{y} values. -## @seealso{meshgrid, contour} +## +## The color of the mesh is derirved from the @code{colormap} +## and the value of @var{z}. Optionally the color of the mesh can be +## specified independent of of @var{z}, by adding a fourth matrix, @var{c}. +## @seealso{colormap, contour, meshgrid, surf} ## @end deftypefn ## Author: jwe
--- a/scripts/plot/surf.m +++ b/scripts/plot/surf.m @@ -18,13 +18,21 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} surf (@var{x}, @var{y}, @var{z}) +## @deftypefnx {Function File} {} surf (@var{z}) +## @deftypefnx {Function File} {} surf (@dots{}, @var{c}) +## @deftypefnx {Function File} {} surf (@var{hax}, @dots{}) +## @deftypefnx {Function File} {@var{h} = } surf (@dots{}) ## Plot a surface given matrices @var{x}, and @var{y} from @code{meshgrid} and ## a matrix @var{z} corresponding to the @var{x} and @var{y} coordinates of ## the mesh. If @var{x} and @var{y} are vectors, then a typical vertex ## is (@var{x}(j), @var{y}(i), @var{z}(i,j)). Thus, columns of @var{z} ## correspond to different @var{x} values and rows of @var{z} correspond ## to different @var{y} values. -## @seealso{mesh, surface} +## +## The color of the surface is derirved from the @code{colormap} and +## the value of @var{z}. Optionally the color of the surface can be +## specified independent of of @var{z}, by adding a fourth matrix, @var{c}. +## @seealso{colormap, contour, meshgrid, mesh} ## @end deftypefn ## Author: Kai Habel <kai.habel@gmx.de>