changeset 12267:8ef6a4373310 release-3-4-x

Add undocumented function trisurf to manual.
author Rik <octave@nomad.inbox5.com>
date Thu, 27 Jan 2011 19:12:31 -0800
parents a319d7ed61c6
children ee94cb52433f
files doc/ChangeLog doc/interpreter/geometry.txi scripts/ChangeLog scripts/geometry/trimesh.m scripts/geometry/triplot.m scripts/geometry/trisurf.m
diffstat 6 files changed, 25 insertions(+), 13 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Thu Jan 27 18:46:33 2011 -0500
+++ b/doc/ChangeLog	Thu Jan 27 19:12:31 2011 -0800
@@ -1,3 +1,7 @@
+2011-01-27  Rik  <octave@nomad.inbox5.com>
+
+	* interpreter/geometry.txi: Add trisurf to documentation.
+
 2011-01-27  John W. Eaton  <jwe@octave.org>
 
 	* interpreter/arith.txi (Rational Approximations): Move here.
--- a/doc/interpreter/geometry.txi	Thu Jan 27 18:46:33 2011 -0500
+++ b/doc/interpreter/geometry.txi	Thu Jan 27 19:12:31 2011 -0800
@@ -94,17 +94,19 @@
 @node Plotting the Triangulation
 @subsection Plotting the Triangulation
 
-Octave has the functions @code{triplot} and @code{trimesh} to plot the
-Delaunay triangulation of a 2-dimensional set of points.
+Octave has the functions @code{triplot}, @code{trimesh}, and @code{trisurf}
+to plot the Delaunay triangulation of a 2-dimensional set of points.
 
 @DOCSTRING(triplot)
 
 @DOCSTRING(trimesh)
 
-The difference between @code{triplot} and @code{trimesh} is that the
-former only plots the 2-dimensional triangulation itself, whereas the
-second plots the value of some function @code{f (@var{x}, @var{y})}.
-An example of the use of the @code{triplot} function is
+@DOCSTRING(trisurf)
+
+The difference between @code{triplot}, and @code{trimesh} or @code{triplot},
+is that the former only plots the 2-dimensional triangulation itself, whereas
+the second two plot the value of a function @code{f (@var{x}, @var{y})}.  An
+example of the use of the @code{triplot} function is
 
 @example
 @group
@@ -117,7 +119,7 @@
 @end example
 
 @noindent
-that plot the Delaunay triangulation of a set of random points in
+which plots the Delaunay triangulation of a set of random points in
 2-dimensions.
 @ifnotinfo
 The output of the above can be seen in @ref{fig:triplot}.
--- a/scripts/ChangeLog	Thu Jan 27 18:46:33 2011 -0500
+++ b/scripts/ChangeLog	Thu Jan 27 19:12:31 2011 -0800
@@ -1,3 +1,9 @@
+2011-01-27  Rik  <octave@nomad.inbox5.com>
+
+	* geometry/trimesh.m, geometry/triplot.m, geometry/trisurf.m: Add
+	undocumented function trisurf to documentation.  Update seealso
+	strings.
+
 2011-01-27  John W. Eaton  <jwe@octave.org>
 
 	* general/rat.m: Move @seealso inside @deftypefn in docstring.
--- a/scripts/geometry/trimesh.m	Thu Jan 27 18:46:33 2011 -0500
+++ b/scripts/geometry/trimesh.m	Thu Jan 27 19:12:31 2011 -0800
@@ -23,8 +23,8 @@
 ## meshing of the points @code{(@var{x}, @var{y})} which is returned
 ## from @code{delaunay}.  The variable @var{z} is value at the point
 ## @code{(@var{x}, @var{y})}.  The output argument @var{h} is the graphic
-## handle to the plot.
-## @seealso{triplot, delaunay3}
+## handle of the plot.
+## @seealso{triplot, trisurf, delaunay3}
 ## @end deftypefn
 
 function h = trimesh (tri, x, y, z, varargin)
--- a/scripts/geometry/triplot.m	Thu Jan 27 18:46:33 2011 -0500
+++ b/scripts/geometry/triplot.m	Thu Jan 27 19:12:31 2011 -0800
@@ -24,8 +24,8 @@
 ## meshing of the points @code{(@var{x}, @var{y})} which is returned from
 ## @code{delaunay}.  If given, the @var{linespec} determines the properties
 ## to use for the lines.  The output argument @var{h} is the graphic handle
-## to the plot.
-## @seealso{plot, trimesh, delaunay}
+## of the plot.
+## @seealso{plot, trimesh, trisurf, delaunay}
 ## @end deftypefn
 
 function h = triplot (tri, x, y, varargin)
--- a/scripts/geometry/trisurf.m	Thu Jan 27 18:46:33 2011 -0500
+++ b/scripts/geometry/trisurf.m	Thu Jan 27 19:12:31 2011 -0800
@@ -23,8 +23,8 @@
 ## meshing of the points @code{(@var{x}, @var{y})} which is returned
 ## from @code{delaunay}.  The variable @var{z} is value at the point
 ## @code{(@var{x}, @var{y})}.  The output argument @var{h} is the graphic
-## handle to the plot.
-## @seealso{triplot, delaunay3}
+## handle of the plot.
+## @seealso{triplot, trimesh, delaunay3}
 ## @end deftypefn
 
 function h = trisurf (tri, x, y, z, varargin)