# HG changeset patch
# User Rik <rik@octave.org>
# Date 1380412474 25200
# Node ID fedcd3717ebcb5b544c2627ac9d41848a0c91943
# Parent  c001cddbda669dab6022cd86b51a8e1f0859c925
doc: grammarcheck of documentation before 3.8 release.

* build-aux/mk-opts.pl: Use @qcode macro around quoted code options.

* liboctave/numeric/DASPK-opts.in, liboctave/numeric/LSODE-opts.in:
Use @qcode macro around quoted code options.

* libinterp/corefcn/module.mk, liboctave/numeric/module.mk: Option handlers
must also depend on Perl script mk-opts.pl.

* libinterp/corefcn/bitfcns.cc, scripts/help/type.m, scripts/image/imfinfo.m,
scripts/miscellaneous/dir.m, scripts/plot/stem.m, scripts/plot/stem3.m,
scripts/plot/subplot.m, scripts/specfun/expint.m: grammarcheck of documentation
before 3.8 release.

diff -r c001cddbda66 -r fedcd3717ebc build-aux/mk-opts.pl
--- a/build-aux/mk-opts.pl	Sat Sep 28 16:31:55 2013 -0400
+++ b/build-aux/mk-opts.pl	Sat Sep 28 16:54:34 2013 -0700
@@ -240,7 +240,7 @@
     }
 }
 
-#FIXME: What does this routine do?  And can it be simpler to understand?
+## FIXME: What does this routine do?  And can it be simpler to understand?
 sub get_min_match_len_info
 {
   my ($i, $j, $k);
@@ -924,7 +924,7 @@
 
   for (my $i = 0; $i < $OPT_NUM; $i++)
     {
-      print '@item \"', $NAME[$i], '\"\n\\', "\n";
+      print '@item @qcode{\"', $NAME[$i], '\"}\n\\', "\n";
       print $DOC_ITEM[$i] if $DOC_ITEM[$i];
     }
 
diff -r c001cddbda66 -r fedcd3717ebc libinterp/corefcn/bitfcns.cc
--- a/libinterp/corefcn/bitfcns.cc	Sat Sep 28 16:31:55 2013 -0400
+++ b/libinterp/corefcn/bitfcns.cc	Sat Sep 28 16:54:34 2013 -0700
@@ -657,9 +657,10 @@
 @deftypefnx {Built-in Function} {} flintmax (\"double\")\n\
 @deftypefnx {Built-in Function} {} flintmax (\"single\")\n\
 Return the largest integer that can be represented consecutively in a\n\
-floating point value.  The default class is @qcode{\"double\"}, but @qcode{\"single\"}\n\
-is a valid option.  On IEEE-754 compatible systems, @code{flintmax} is @w{@math{2^53}}\n\
-for @qcode{\"double\"} and @w{@math{2^24}} for @qcode{\"single\"}.\n\
+floating point value.  The default class is @qcode{\"double\"}, but\n\
+@qcode{\"single\"} is a valid option.  On IEEE-754 compatible systems,\n\
+@code{flintmax} is @w{@math{2^53}} for @qcode{\"double\"} and\n\
+@w{@math{2^24}} for @qcode{\"single\"}.\n\
 @seealso{bitmax, intmax, realmax, realmin}\n\
 @end deftypefn")
 {
diff -r c001cddbda66 -r fedcd3717ebc libinterp/corefcn/module.mk
--- a/libinterp/corefcn/module.mk	Sat Sep 28 16:31:55 2013 -0400
+++ b/libinterp/corefcn/module.mk	Sat Sep 28 16:54:34 2013 -0700
@@ -28,6 +28,8 @@
 	$(PERL) $(top_srcdir)/build-aux/mk-opts.pl --opt-handler-fcns $< > $@-t
 	mv $@-t $@
 
+$(OPT_HANDLERS): $(top_srcdir)/build-aux/mk-opts.pl
+
 $(OPT_INC) : %.h : %.in
 	$(MAKE) -C $(top_builddir)/liboctave/numeric $(@F)
 
diff -r c001cddbda66 -r fedcd3717ebc liboctave/numeric/DASPK-opts.in
--- a/liboctave/numeric/DASPK-opts.in	Sat Sep 28 16:31:55 2013 -0400
+++ b/liboctave/numeric/DASPK-opts.in	Sat Sep 28 16:54:34 2013 -0700
@@ -103,7 +103,7 @@
 initial conditions that are consistent).
 
 If this option is set to a nonzero value, you must also set the
-@code{\"algebraic variables\"} option to declare which variables in the
+@qcode{\"algebraic variables\"} option to declare which variables in the
 problem are algebraic.
 
   END_DOC_ITEM
@@ -139,11 +139,11 @@
 
 @item MXNH
 Maximum number of values of the artificial stepsize parameter to be
-tried if the @code{\"compute consistent initial condition\"} option has
+tried if the @qcode{\"compute consistent initial condition\"} option has
 been set to 1 (default is 5).
 
 Note that the maximum total number of Newton iterations allowed is
-@code{MXNIT*MXNJ*MXNH} if the @code{\"compute consistent initial
+@code{MXNIT*MXNJ*MXNH} if the @qcode{\"compute consistent initial
 condition\"} option has been set to 1 and @code{MXNIT*MXNJ} if it is
 set to 2.
 
@@ -194,7 +194,7 @@
   NAME = "exclude algebraic variables from error test"
   DOC_ITEM
 Set to a nonzero value to exclude algebraic variables from the error
-test.  You must also set the @code{\"algebraic variables\"} option to
+test.  You must also set the @qcode{\"algebraic variables\"} option to
 declare which variables in the problem are algebraic (default is 0).
 
   END_DOC_ITEM
@@ -212,8 +212,8 @@
 in the equation set.
 
 This option is required by the
-@code{compute consistent initial condition\"} and
-@code{\"exclude algebraic variables from error test\"} options.
+@qcode{compute consistent initial condition\"} and
+@qcode{\"exclude algebraic variables from error test\"} options.
 
   END_DOC_ITEM
   TYPE = "Array<octave_idx_type>"
@@ -239,7 +239,7 @@
   NAME = "enforce inequality constraints"
   DOC_ITEM
 Set to one of the following values to enforce the inequality
-constraints specified by the @code{\"inequality constraint types\"}
+constraints specified by the @qcode{\"inequality constraint types\"}
 option (default is 0).
 
 @enumerate
@@ -282,7 +282,7 @@
 @end table
 
 This option only has an effect if the
-@code{\"enforce inequality constraints\"} option is nonzero.
+@qcode{\"enforce inequality constraints\"} option is nonzero.
 
   END_DOC_ITEM
   TYPE = "Array<octave_idx_type>"
diff -r c001cddbda66 -r fedcd3717ebc liboctave/numeric/LSODE-opts.in
--- a/liboctave/numeric/LSODE-opts.in	Sat Sep 28 16:31:55 2013 -0400
+++ b/liboctave/numeric/LSODE-opts.in	Sat Sep 28 16:54:34 2013 -0700
@@ -74,12 +74,12 @@
 system.  Valid values are
 
 @table @asis
-@item  \"adams\"
-@itemx \"non-stiff\"
+@item  @qcode{\"adams\"}
+@itemx @qcode{\"non-stiff\"}
 No Jacobian used (even if it is available).
 
-@item  \"bdf\"
-@itemx \"stiff\"
+@item  @qcode{\"bdf\"}
+@itemx @qcode{\"stiff\"}
 Use stiff backward differentiation formula (BDF) method.  If a
 function to compute the Jacobian is not supplied, @code{lsode} will
 compute a finite difference approximation of the Jacobian matrix.
diff -r c001cddbda66 -r fedcd3717ebc liboctave/numeric/module.mk
--- a/liboctave/numeric/module.mk	Sat Sep 28 16:31:55 2013 -0400
+++ b/liboctave/numeric/module.mk	Sat Sep 28 16:54:34 2013 -0700
@@ -168,11 +168,13 @@
   numeric/sparse-dmsolve.cc
 
 ## Special rules for sources which must be built before rest of compilation.
-$(OPT_INC) : %.h : %.in $(top_srcdir)/build-aux/mk-opts.pl
+$(OPT_INC) : %.h : %.in
 	@echo making $@ from $<
 	@$(PERL) $(top_srcdir)/build-aux/mk-opts.pl --opt-class-header $< > $@-t
 	mv $@-t $@
 
+$(OPT_INC) : $(top_srcdir)/build-aux/mk-opts.pl
+
 noinst_LTLIBRARIES += numeric/libnumeric.la
 
 numeric_libnumeric_la_SOURCES = $(NUMERIC_SRC)
diff -r c001cddbda66 -r fedcd3717ebc scripts/help/type.m
--- a/scripts/help/type.m	Sat Sep 28 16:31:55 2013 -0400
+++ b/scripts/help/type.m	Sat Sep 28 16:54:34 2013 -0700
@@ -24,7 +24,7 @@
 ## variable, operator, or keyword.
 ##
 ## @code{type} normally prepends a header line describing the category
-## of @var{name} such as function or variable;  The @option{-q} option
+## of @var{name} such as function or variable; The @option{-q} option
 ## suppresses this behavior.
 ##
 ## If no output variable is used the contents are displayed on screen.
diff -r c001cddbda66 -r fedcd3717ebc scripts/image/imfinfo.m
--- a/scripts/image/imfinfo.m	Sat Sep 28 16:31:55 2013 -0400
+++ b/scripts/image/imfinfo.m	Sat Sep 28 16:54:34 2013 -0700
@@ -108,7 +108,7 @@
 ## @item Orientation
 ## The orientation of the image with respect to the rows and columns.  Value
 ## is an integer between 1 and 8 as defined in the TIFF 6 specifications, and
-## for @sc{Matlab} compatibility.
+## for @sc{matlab} compatibility.
 ##
 ## @item Software
 ## Name and version of the software or firmware of the camera or image input
@@ -123,7 +123,7 @@
 ## on the field @qcode{"Make"}.
 ##
 ## @item DateTime
-## The date and time of image creation as defined by the Exif standard, i.e,
+## The date and time of image creation as defined by the Exif standard, i.e.,
 ## it is the date and time the file was changed.
 ##
 ## @item ImageDescription
diff -r c001cddbda66 -r fedcd3717ebc scripts/miscellaneous/dir.m
--- a/scripts/miscellaneous/dir.m	Sat Sep 28 16:31:55 2013 -0400
+++ b/scripts/miscellaneous/dir.m	Sat Sep 28 16:54:34 2013 -0700
@@ -29,14 +29,19 @@
 ## @table @asis
 ## @item name
 ## File or directory name. 
+##
 ## @item date
 ## Timestamp of file modification (string value).
+##
 ## @item bytes
 ## File size in bytes.
+##
 ## @item isdir
 ## True if name is a directory. 
+##
 ## @item datenum
 ## Timestamp of file modification as serial date number (double).
+##
 ## @item statinfo
 ## Information structure returned from @code{stat}.
 ## @end table
diff -r c001cddbda66 -r fedcd3717ebc scripts/plot/stem.m
--- a/scripts/plot/stem.m	Sat Sep 28 16:31:55 2013 -0400
+++ b/scripts/plot/stem.m	Sat Sep 28 16:54:34 2013 -0700
@@ -57,11 +57,11 @@
 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
 ## rather than the current axes returned by @code{gca}.
 ##
-## The optional return value @var{h} is a handle to a "stem series" hggroup.
-## The single hggroup handle has all of the graphical elements comprising the
-## plot as its children; This allows the properties of multiple graphics
-## objects to be changed by modifying just a single property of the
-## "stem series" hggroup.
+## The optional return value @var{h} is a handle to a @nospell{"stem series"}
+## hggroup.  The single hggroup handle has all of the graphical elements
+## comprising the plot as its children; This allows the properties of
+## multiple graphics objects to be changed by modifying just a single
+## property of the @nospell{"stem series"} hggroup.
 ##
 ## For example,
 ##
@@ -76,8 +76,8 @@
 ## @end example
 ##
 ## @noindent
-## changes the color of the second "stem series" and moves the base line
-## of the first.
+## changes the color of the second @nospell{"stem series"} and moves the base
+## line of the first.
 ##
 ## Stem Series Properties
 ##
@@ -90,7 +90,7 @@
 ##
 ## @item color
 ## The color of the stem, and if not separately specified, the marker.
-## (Default: "b" [blue])
+## (Default: @qcode{"b"} [blue])
 ##
 ## @item marker
 ## The marker symbol to use at the top of each stem.  (Default: @qcode{"o"})
@@ -99,8 +99,8 @@
 ## The edge color of the marker.  (Default: @qcode{"color"} property)
 ##
 ## @item markerfacecolor
-## The color to use for "filling" the marker.  (Default: @qcode{"none"}
-## [unfilled])
+## The color to use for @nospell{"filling"} the marker.  
+## (Default: @qcode{"none"} [unfilled])
 ##
 ## @item markersize
 ## The size of the marker.  (Default: 6)
diff -r c001cddbda66 -r fedcd3717ebc scripts/plot/stem3.m
--- a/scripts/plot/stem3.m	Sat Sep 28 16:31:55 2013 -0400
+++ b/scripts/plot/stem3.m	Sat Sep 28 16:54:34 2013 -0700
@@ -39,9 +39,10 @@
 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
 ## rather than the current axes returned by @code{gca}.
 ##
-## The optional return value @var{h} is a handle to the "stem series" hggroup
-## containing the line and marker objects used for the plot.
-## @xref{XREFstem,,stem}, for a description of the "stem series" object.
+## The optional return value @var{h} is a handle to the @nospell{"stem series"}
+## hggroup containing the line and marker objects used for the plot.
+## @xref{XREFstem,,stem}, for a description of the @nospell{"stem series"}
+## object.
 ##
 ## Example:
 ##
diff -r c001cddbda66 -r fedcd3717ebc scripts/plot/subplot.m
--- a/scripts/plot/subplot.m	Sat Sep 28 16:31:55 2013 -0400
+++ b/scripts/plot/subplot.m	Sat Sep 28 16:54:34 2013 -0700
@@ -29,7 +29,7 @@
 ## current axes for plotting (@code{gca}) to the location given by @var{index}.
 ##
 ## If only one numeric argument is supplied, then it must be a three digit
-## value specifying the the number of rows in in digit 1, the number of
+## value specifying the number of rows in digit 1, the number of
 ## columns in digit 2, and the plot index in digit 3.
 ##
 ## The plot index runs row-wise; First, all columns in a row are numbered
diff -r c001cddbda66 -r fedcd3717ebc scripts/specfun/expint.m
--- a/scripts/specfun/expint.m	Sat Sep 28 16:31:55 2013 -0400
+++ b/scripts/specfun/expint.m	Sat Sep 28 16:54:34 2013 -0700
@@ -37,8 +37,8 @@
 ##          x
 ## @end group
 ## @end example
+##
 ## @end ifnottex
-##
 ## Note: For compatibility, this functions uses the @sc{matlab} definition
 ## of the exponential integral.  Most other sources refer to this particular
 ## value as @math{E_1 (x)}, and the exponential integral is
@@ -58,8 +58,8 @@
 ##          -x
 ## @end group
 ## @end example
+##
 ## @end ifnottex
-##
 ## The two definititions are related, for positive real values of @var{x}, by
 ## @tex
 ## $