changeset 12529:0579a13f29a1

Add isocolors, isonormals, isosurface functions to documentation.
author Rik <octave@nomad.inbox5.com>
date Sat, 19 Mar 2011 13:06:50 -0700
parents 2ac5028e5cb7
children d70c99028ba3
files doc/ChangeLog doc/interpreter/plot.txi scripts/ChangeLog scripts/plot/isocolors.m scripts/plot/isonormals.m scripts/plot/isosurface.m
diffstat 6 files changed, 22 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Sat Mar 19 12:54:05 2011 -0700
+++ b/doc/ChangeLog	Sat Mar 19 13:06:50 2011 -0700
@@ -1,3 +1,8 @@
+2010-03-19  Rik  <octave@nomad.inbox5.com>
+
+	* interpreter/plot.txi: Add isocolors, isonormals, isosurface functions
+	to documentation.
+
 2010-03-19  Rik  <octave@nomad.inbox5.com>
 
 	* interpreter/basics.txi: Add dump_prefs to documentation.
--- a/doc/interpreter/plot.txi	Sat Mar 19 12:54:05 2011 -0700
+++ b/doc/interpreter/plot.txi	Sat Mar 19 13:06:50 2011 -0700
@@ -347,6 +347,12 @@
 
 @DOCSTRING(surfnorm)
 
+@DOCSTRING(isosurface)
+
+@DOCSTRING(isonormals)
+
+@DOCSTRING(isocolors)
+
 @DOCSTRING(diffuse)
 
 @DOCSTRING(specular)
--- a/scripts/ChangeLog	Sat Mar 19 12:54:05 2011 -0700
+++ b/scripts/ChangeLog	Sat Mar 19 13:06:50 2011 -0700
@@ -1,3 +1,8 @@
+2010-03-19  Rik  <octave@nomad.inbox5.com>
+
+	* plot/isocolors.m, plot/isonormals.m, plot/isosurface.m: Improve
+	docstrings.
+
 2010-03-19  Rik  <octave@nomad.inbox5.com>
 
 	* miscellaneous/dump_prefs.m: Close @deftypefn macro left open.
--- a/scripts/plot/isocolors.m	Sat Mar 19 12:54:05 2011 -0700
+++ b/scripts/plot/isocolors.m	Sat Mar 19 13:06:50 2011 -0700
@@ -25,7 +25,7 @@
 ## @deftypefnx {Function File} isocolors (@dots{})
 ##
 ## If called with one output argument and the first input argument
-## @var{c} is a three--dimensional array that contains color values and
+## @var{c} is a three-dimensional array that contains color values and
 ## the second input argument @var{v} keeps the vertices of a geometry
 ## then return a matrix @var{cd} with color data information for the
 ## geometry at computed points
@@ -92,7 +92,7 @@
 ## isofinish (p);
 ## @end example
 ##
-## @seealso{isosurface, isonormals, isocaps}
+## @seealso{isosurface, isonormals}
 ##
 ## @end deftypefn
 
--- a/scripts/plot/isonormals.m	Sat Mar 19 12:54:05 2011 -0700
+++ b/scripts/plot/isonormals.m	Sat Mar 19 13:06:50 2011 -0700
@@ -25,7 +25,7 @@
 ## @deftypefnx {Function File} isonormals (@dots{}, @var{p})
 ##
 ## If called with one output argument and the first input argument
-## @var{val} is a three--dimensional array that contains the data for an
+## @var{val} is a three-dimensional array that contains the data for an
 ## isosurface geometry and the second input argument @var{v} keeps the
 ## vertices of an isosurface then return the normals @var{n} in form of
 ## a matrix with the same size than @var{v} at computed points
@@ -88,8 +88,7 @@
 ## isofinish (p);
 ## @end example
 ##
-## @seealso {isosurface, isocolors, isocaps, marching_cube}
-##
+## @seealso{isosurface, isocolors}
 ## @end deftypefn
 
 ## Author: Martin Helm <martin@mhelm.de>
--- a/scripts/plot/isosurface.m	Sat Mar 19 12:54:05 2011 -0700
+++ b/scripts/plot/isosurface.m	Sat Mar 19 13:06:50 2011 -0700
@@ -26,7 +26,7 @@
 ## @deftypefnx {Function File} {} isosurface (@var{x}, @var{y}, @var{z}, @var{val}, @var{iso}, @var{col}, @var{opt})
 ##
 ## If called with one output argument and the first input argument
-## @var{val} is a three--dimensional array that contains the data of an
+## @var{val} is a three-dimensional array that contains the data of an
 ## isosurface geometry and the second input argument @var{iso} keeps the
 ## isovalue as a scalar value then return a structure array @var{fv}
 ## that contains the fields @var{Faces} and @var{Vertices} at computed
@@ -108,8 +108,7 @@
 ## # light ("Position", [1 1 5]);
 ## @end example
 ##
-## @seealso{isocolors, isonormals, isocaps}
-##
+## @seealso{isonormals, isocolors}
 ## @end deftypefn
 
 ## Author: Martin Helm <martin@mhelm.de>