changeset 19829:ca7599ae464d

doc: Grammarcheck documentation ahead of 4.0 release. * plot.txi, data.cc, graphics.cc, ordschur.cc, __ilu__.cc, __osmesa_print__.cc, audiodevinfo.cc, soundsc.m, interp2.m, interp3.m, interpn.m, annotation.m, zoom.m: Grammarcheck documentation ahead of 4.0 release.
author Rik <rik@octave.org>
date Fri, 20 Feb 2015 14:26:36 -0800
parents f6836e4b1cb5
children a0c9c85860c0
files doc/interpreter/plot.txi libinterp/corefcn/data.cc libinterp/corefcn/graphics.cc libinterp/corefcn/ordschur.cc libinterp/dldfcn/__ilu__.cc libinterp/dldfcn/__osmesa_print__.cc libinterp/dldfcn/audiodevinfo.cc scripts/audio/soundsc.m scripts/general/interp2.m scripts/general/interp3.m scripts/general/interpn.m scripts/plot/draw/annotation.m scripts/plot/util/zoom.m
diffstat 13 files changed, 54 insertions(+), 46 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/plot.txi	Fri Feb 20 14:24:17 2015 -0800
+++ b/doc/interpreter/plot.txi	Fri Feb 20 14:26:36 2015 -0800
@@ -468,7 +468,9 @@
 and border lines to the plot.  By default, the grid is off and the
 border lines are on.
 
-Finally, arrows, text and rectangular or elliptic boxes can be added to highlight parts of a plot using the @code{annotation} function. Those objects are drawn in an invisible axes, on top of every other axes.
+Finally, arrows, text and rectangular or elliptic boxes can be added to
+highlight parts of a plot using the @code{annotation} function.  Those objects
+are drawn in an invisible axes, on top of every other axes.
 
 @DOCSTRING(title)
 
--- a/libinterp/corefcn/data.cc	Fri Feb 20 14:24:17 2015 -0800
+++ b/libinterp/corefcn/data.cc	Fri Feb 20 14:26:36 2015 -0800
@@ -3753,7 +3753,7 @@
 DEFUN (isrow, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Function File} {} isrow (@var{x})\n\
-Return true if @var{x} is a row vector 1xN with nonnegative N.\n\
+Return true if @var{x} is a row vector 1xN with non-negative N.\n\
 @seealso{iscolumn, isscalar, isvector, ismatrix}\n\
 @end deftypefn")
 {
@@ -3803,7 +3803,7 @@
 DEFUN (iscolumn, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Function File} {} iscolumn (@var{x})\n\
-Return true if @var{x} is a column vector Nx1 with nonnegative N.\n\
+Return true if @var{x} is a column vector Nx1 with non-negative N.\n\
 @seealso{isrow, isscalar, isvector, ismatrix}\n\
 @end deftypefn")
 {
@@ -3852,7 +3852,7 @@
 DEFUN (ismatrix, args, ,
        "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} ismatrix (@var{a})\n\
-Return true if @var{a} is has exactly two nonnegative dimensions.\n\
+Return true if @var{a} is a 2-D array.\n\
 @seealso{isscalar, isvector, iscell, isstruct, issparse, isa}\n\
 @end deftypefn")
 {
@@ -6265,8 +6265,9 @@
 DEFUN (colon, args, ,
        "-*- texinfo -*-\n\
 @deftypefn  {Built-in Function} {@var{r} =} colon (@var{base}, @var{limit})\n\
-@deftypefnx  {Built-in Function} {@var{r} =} colon (@var{base}, @var{increment}, @var{limit})\n\
-Return the result of the colon expression corresponding to @var{base}, @var{limit}, and optionally, @var{increment}.\n\
+@deftypefnx {Built-in Function} {@var{r} =} colon (@var{base}, @var{increment}, @var{limit})\n\
+Return the result of the colon expression corresponding to @var{base},\n\
+@var{limit}, and optionally, @var{increment}.\n\
 \n\
 This function is equivalent to the operator syntax @w{@code{base : limit}}\n\
 or @w{@code{base : increment : limit}}.\n\
--- a/libinterp/corefcn/graphics.cc	Fri Feb 20 14:24:17 2015 -0800
+++ b/libinterp/corefcn/graphics.cc	Fri Feb 20 14:26:36 2015 -0800
@@ -11815,8 +11815,8 @@
 DEFUN (__zoom__, args, ,
        "-*- texinfo -*-\n\
 @deftypefn  {Built-in Function} {} __zoom__ (@var{axes}, @var{mode}, @var{factor})\n\
-@deftypefnx  {Built-in Function} {} __zoom__ (@var{axes}, \"out\")\n\
-@deftypefnx  {Built-in Function} {} __zoom__ (@var{axes}, \"reset\")\n\
+@deftypefnx {Built-in Function} {} __zoom__ (@var{axes}, \"out\")\n\
+@deftypefnx {Built-in Function} {} __zoom__ (@var{axes}, \"reset\")\n\
 Undocumented internal function.\n\
 @end deftypefn")
 {
--- a/libinterp/corefcn/ordschur.cc	Fri Feb 20 14:24:17 2015 -0800
+++ b/libinterp/corefcn/ordschur.cc	Fri Feb 20 14:26:36 2015 -0800
@@ -78,6 +78,7 @@
 [@var{U}, @var{S}] = schur (@var{A})\n\
 @end example\n\
 \n\
+@noindent\n\
 which returns\n\
 \n\
 @example\n\
@@ -95,8 +96,8 @@
 @end group\n\
 @end example\n\
 \n\
-It is possible to reorder the decomposition so that the positive eigenvalue is\n\
-in the upper left corner, by doing:\n\
+It is possible to reorder the decomposition so that the positive eigenvalue\n\
+is in the upper left corner, by doing:\n\
 \n\
 @example\n\
 [@var{U}, @var{S}] = ordschur (@var{U}, @var{S}, [0,1])\n\
--- a/libinterp/dldfcn/__ilu__.cc	Fri Feb 20 14:24:17 2015 -0800
+++ b/libinterp/dldfcn/__ilu__.cc	Fri Feb 20 14:26:36 2015 -0800
@@ -126,9 +126,9 @@
 }
 
 DEFUN_DLD (__ilu0__, args, nargout, "-*- texinfo -*-\n\
-@deftypefn   {Loadable Function} {[@var{L}, @var{U}] =} __ilu0__ (@var{A})\n\
-@deftypefnx  {Loadable Function} {[@var{L}, @var{U}] =} __ilu0__ (@var{A}, @var{milu})\n\
-@deftypefnx  {Loadable Function} {[@var{L}, @var{U}, @var{P}] =} __ilu0__ (@var{A}, @dots{})\n\
+@deftypefn  {Loadable Function} {[@var{L}, @var{U}] =} __ilu0__ (@var{A})\n\
+@deftypefnx {Loadable Function} {[@var{L}, @var{U}] =} __ilu0__ (@var{A}, @var{milu})\n\
+@deftypefnx {Loadable Function} {[@var{L}, @var{U}, @var{P}] =} __ilu0__ (@var{A}, @dots{})\n\
 Undocumented internal function.\n\
 @end deftypefn")
 {
--- a/libinterp/dldfcn/__osmesa_print__.cc	Fri Feb 20 14:24:17 2015 -0800
+++ b/libinterp/dldfcn/__osmesa_print__.cc	Fri Feb 20 14:26:36 2015 -0800
@@ -58,23 +58,26 @@
 
 DEFUN_DLD(__osmesa_print__, args, ,
           "-*- texinfo -*-\n\
-@deftypefn {Loadable Function}  __osmesa_print__ (@var{h}, @var{file}, @var{term})\n\
-@deftypefnx {Loadable Function} {@var{img}  =} __osmesa_print__ (@var{h})\n\
+@deftypefn  {Loadable Function} {} __osmesa_print__ (@var{h}, @var{file}, @var{term})\n\
+@deftypefnx {Loadable Function} {@var{img} =} __osmesa_print__ (@var{h})\n\
 Print figure @var{h} using OSMesa and gl2ps for vector formats.\n\
 \n\
 This is a private internal function.\n\
 \n\
 The first method calls gl2ps with the appropriate @var{term} and writes\n\
-the output of gl2ps to @var{file}. If the first character of @var{file}\n\
+the output of gl2ps to @var{file}.  If the first character of @var{file}\n\
 is @qcode{|}, then a process is started and the output of gl2ps is piped\n\
 to it.\n\
 \n\
 Valid options for @var{term}, which can be concatenated in one string, are:\n\
+\n\
 @table @asis\n\
 @item @qcode{eps}, @qcode{pdf}, @qcode{ps}, @qcode{svg}, @qcode{pgf}, @qcode{tex}\n\
 Select output format.\n\
+\n\
 @item @qcode{is2D}\n\
 Use GL2PS_SIMPLE_SORT instead of GL2PS_BSP_SORT as Z-depth sorting algorithm.\n\
+\n\
 @item @qcode{notext}\n\
 Don't render text.\n\
 @end table\n\
--- a/libinterp/dldfcn/audiodevinfo.cc	Fri Feb 20 14:24:17 2015 -0800
+++ b/libinterp/dldfcn/audiodevinfo.cc	Fri Feb 20 14:26:36 2015 -0800
@@ -81,7 +81,6 @@
 The value of each field is a structure array with fields\n\
 \"Name\", @nospell{\"DriverVersion\"} and \"ID\" describing an audio device.\n\
 \n\
-\n\
 If the optional argument @var{io} is 1, return information about input\n\
 devices only.  If it is 0, return information about output devices only.\n\
 \n\
--- a/scripts/audio/soundsc.m	Fri Feb 20 14:24:17 2015 -0800
+++ b/scripts/audio/soundsc.m	Fri Feb 20 14:26:36 2015 -0800
@@ -28,8 +28,8 @@
 ##
 ## By default, @var{y} is automatically normalized to the range [-1, 1].  If the
 ## range [@var{ymin}, @var{ymax}] is given, then elements of @var{y} that fall
-## within the range @var{ymin} @leq{} @var{y} @leq{} @var{ymax} are scaled to the
-## range [-1, 1] instead.
+## within the range @var{ymin} @leq{} @var{y} @leq{} @var{ymax} are scaled to
+## the range [-1, 1] instead.
 ##
 ## The audio signal @var{y} can be a vector or a two-column array, representing
 ## mono or stereo audio, respectively.
--- a/scripts/general/interp2.m	Fri Feb 20 14:24:17 2015 -0800
+++ b/scripts/general/interp2.m	Fri Feb 20 14:26:36 2015 -0800
@@ -70,7 +70,7 @@
 ## throughout the curve.
 ## @end table
 ##
-## @var{extrap} is a scalar number. It replaces values beyond the endpoints
+## @var{extrap} is a scalar number.  It replaces values beyond the endpoints
 ## with @var{extrap}.  Note that if @var{extrapval} is used, @var{method} must
 ## be specified as well.  If @var{extrap} is omitted and the @var{method} is
 ## @qcode{"spline"}, then the extrapolated values of the @qcode{"spline"} are
--- a/scripts/general/interp3.m	Fri Feb 20 14:24:17 2015 -0800
+++ b/scripts/general/interp3.m	Fri Feb 20 14:26:36 2015 -0800
@@ -70,7 +70,7 @@
 ## throughout the curve.
 ## @end table
 ##
-## @var{extrapval} is a scalar number. It replaces values beyond the endpoints
+## @var{extrapval} is a scalar number.  It replaces values beyond the endpoints
 ## with @var{extrapval}.  Note that if @var{extrapval} is used, @var{method}
 ## must be specified as well.  If @var{extrapval} is omitted and the
 ## @var{method} is @qcode{"spline"}, then the extrapolated values of the
--- a/scripts/general/interpn.m	Fri Feb 20 14:24:17 2015 -0800
+++ b/scripts/general/interpn.m	Fri Feb 20 14:26:36 2015 -0800
@@ -62,7 +62,7 @@
 ##
 ## The default method is @qcode{"linear"}.
 ##
-## @var{extrapval} is a scalar number. It replaces values beyond the endpoints
+## @var{extrapval} is a scalar number.  It replaces values beyond the endpoints
 ## with @var{extrapval}.  Note that if @var{extrapval} is used, @var{method}
 ## must be specified as well.  If @var{extrapval} is omitted and the
 ## @var{method} is @qcode{"spline"}, then the extrapolated values of the
--- a/scripts/plot/draw/annotation.m	Fri Feb 20 14:24:17 2015 -0800
+++ b/scripts/plot/draw/annotation.m	Fri Feb 20 14:26:36 2015 -0800
@@ -15,7 +15,7 @@
 ##   <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} annotation (@var{type})
+## @deftypefn  {Function File} {} annotation (@var{type})
 ## @deftypefnx {Function File} {} annotation ("line", @var{x}, @var{y})
 ## @deftypefnx {Function File} {} annotation ("arrow", @var{x}, @var{y})
 ## @deftypefnx {Function File} {} annotation ("doublearrow", @var{x}, @var{y})
@@ -29,7 +29,7 @@
 ## Draw annotations to emphasize parts of a figure.
 ##
 ## You may build a default annotation specifying only the type
-## @var{type} of the annotation. Otherwise you can set the position of
+## @var{type} of the annotation.  Otherwise you can set the position of
 ## the annotation using either @var{x} and @var{y} coordinates for
 ## line-based annotations or a position vector @var{pos} for others.
 ## In any case, coordinates are interpreted using the @qcode{"units"}
@@ -40,16 +40,17 @@
 ##
 ## The figure on which the annotations should be drawn may be 
 ## specified by providing its graphics handle @var{hf} before any
-## other argument. Otherwise annotations are drawn on the current
+## other argument.  Otherwise annotations are drawn on the current
 ## figure. 
 ## 
 ## Further arguments can be provided in the form of
-## @var{prop}/@var{val} pairs to customize the annotation  appearance
-## and the units in which coordinates are interpreted. The annotation
+## @var{prop}/@var{val} pairs to customize the annotation appearance
+## and the units in which coordinates are interpreted.  The annotation
 ## can also be customized afterward using its graphics handle 
 ## @var{h} and @code{set} function.
 ## 
 ## All annotation objects share two properties:
+##
 ## @itemize
 ## @item
 ##  @qcode{"units"}: the units in which coordinates are interpreted.
@@ -59,43 +60,44 @@
 ##
 ## @item
 ##  @qcode{"position"}: a four elements vector [x0 y0 width height]
-##  specifying  the coordinates (x0,y0) of the origin of the annotation
-##  object, its width and its height. The width and height may be
+##  specifying the coordinates (x0,y0) of the origin of the annotation
+##  object, its width and its height.  The width and height may be
 ##  negative, depending on the orientation of the object.
-##   
+##
 ## @end itemize
 ##
 ## Valid annotation types and their specific properties are described
 ## bellow: 
+##
 ## @table @asis
 ## @item @qcode{"line"}
-##  Constructs a line. @var{x} and @var{y} must be two
+##  Constructs a line.  @var{x} and @var{y} must be two
 ##  elements vectors specifying the x and y coordinates of the two
 ##  ends of the line.
 ##
 ##  The line can be customized using @qcode{"linewidth"},
 ##  @qcode{"linestyle"} and @qcode{"color"} properties the same way
-##  as with @code{line} objects.   
+##  as with @code{line} objects.
 ##
 ## @item  @qcode{"arrow"}
-##   Construct an arrow. The second point in vectors @var{x} and
+##   Construct an arrow.  The second point in vectors @var{x} and
 ##   @var{y} specifies the arrowhead coordinates.
 ##
 ##  Besides line properties, the arrowhead can be customized using
 ##  @qcode{"headlength"}, @qcode{"headwidth"} and @qcode{"headstyle"}
-##  properties. Supported values for @qcode{"headstyle"} property are:
+##  properties.  Supported values for @qcode{"headstyle"} property are:
 ##  [@qcode{"diamond"} | @qcode{"ellipse"} | @qcode{"plain"} |
 ##  @qcode{"rectangle"} | @qcode{"vback1"} | @qcode{"@{vback2@}"} | 
 ##  @qcode{"vback3"}] 
 ## 
 ## @item  @qcode{"doublearrow"}
-##   Construct a double arrow. Vectors @var{x} and @var{y} specify the
+##   Construct a double arrow.  Vectors @var{x} and @var{y} specify the
 ##   arrowheads coordinates.
 ##
 ##  The line and the arrowhead can be customized as for arrow
 ##  annotations but some property names are duplicated:
 ##  @qcode{"head1length"}/@qcode{"head2length"},
-##  @qcode{"head1width"}/@qcode{"head2width"}, etc. The index 1 marks
+##  @qcode{"head1width"}/@qcode{"head2width"}, etc.  The index 1 marks
 ##  the properties of the arrowhead at the first point in @var{x} and
 ##  @var{y} coordinates. 
 ##
@@ -105,31 +107,31 @@
 ##
 ##  The line and the arrowhead can be customized as for arrow
 ##  annotations, and the text can be customized using the same
-##  properties as @code{text} graphics objects. Note however
+##  properties as @code{text} graphics objects.  Note however
 ##  that some text property names are prefixed with "text" to
 ##  distinguish arrow and text properties:
 ##  @qcode{"textbackgroundcolor"}, @qcode{"textcolor"},
 ##  @qcode{"textedgecolor"}, @qcode{"textlinewidth"},
 ##  @qcode{"textmargin"}, @qcode{"textrotation"}.
-##   
+##
 ## @item  @qcode{"textbox"}
-##  Construct a box with a text inside. @var{pos} specifies the
+##  Construct a box with a text inside.  @var{pos} specifies the
 ##  @qcode{"position"} property of the annotation.
 ##
 ##  You may use @qcode{"backgroundcolor"}, @qcode{"edgecolor"},
 ##  @qcode{"linestyle"} , @qcode{"linewidth"} properties to customize
-##  the box background color and edges appearance. A limited set of
+##  the box background color and edges appearance.  A limited set of
 ##  @code{text} objects properties is also available: besides
-##  @qcode{"font..."} properties, you may also use
+##  @qcode{"font@dots{}"} properties, you may also use
 ##  @qcode{"horizontalalignment"} and @qcode{"verticalalignment"} to
 ##  move the text inside the box.
 ##
 ##  Finally the  @qcode{"fitboxtotext"} property controls the actual
-##  extent of the box. If @qcode{"on"} (the default) the
+##  extent of the box.  If @qcode{"on"} (the default) the
 ##  box limits are fitted to the text extent.
 ##
 ## @item  @qcode{"rectangle"}
-##  Construct a rectangle. @var{pos} specifies the
+##  Construct a rectangle.  @var{pos} specifies the
 ##  @qcode{"position"} property of the annotation. 
 ##
 ##  You may use @qcode{"facecolor"}, @qcode{"color"},
@@ -137,7 +139,7 @@
 ##  the rectangle background color and edges appearance.
 ##
 ## @item  @qcode{"ellipse"}
-##  Construct an ellipse. @var{pos} specifies the
+##  Construct an ellipse.  @var{pos} specifies the
 ##  @qcode{"position"} property of the annotation. 
 ##
 ##  See @qcode{"rectangle"} annotations for customization. 
--- a/scripts/plot/util/zoom.m	Fri Feb 20 14:24:17 2015 -0800
+++ b/scripts/plot/util/zoom.m	Fri Feb 20 14:26:36 2015 -0800
@@ -17,8 +17,8 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Command} {} zoom
-## @deftypefnx  {Command} {} zoom (@var{factor})
+## @deftypefn  {Command} {} zoom
+## @deftypefnx {Command} {} zoom (@var{factor})
 ## @deftypefnx {Command} {} zoom on
 ## @deftypefnx {Command} {} zoom off
 ## @deftypefnx {Command} {} zoom xon