changeset 27800:afbaad39d25c

doc: grammarcheck C++ files in libinterp/ directory. * debug.cc, event-manager.cc, file-io.cc, stream-euler.cc, strfns.cc, urlwrite.cc, dmperm.cc: grammarcheck C++ files in libinterp/ directory.
author Rik <rik@octave.org>
date Tue, 10 Dec 2019 13:19:07 -0800
parents 45ad2127582b
children e7dd7d98a058
files libinterp/corefcn/debug.cc libinterp/corefcn/event-manager.cc libinterp/corefcn/file-io.cc libinterp/corefcn/stream-euler.cc libinterp/corefcn/strfns.cc libinterp/corefcn/urlwrite.cc libinterp/dldfcn/dmperm.cc
diffstat 7 files changed, 19 insertions(+), 17 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/debug.cc	Tue Dec 10 12:19:09 2019 -0800
+++ b/libinterp/corefcn/debug.cc	Tue Dec 10 13:19:07 2019 -0800
@@ -1144,7 +1144,7 @@
 
 DEFMETHOD (dbquit, interp, args, ,
            doc: /* -*- texinfo -*-
-@deftypefn {} {} dbquit
+@deftypefn  {} {} dbquit
 @deftypefnx {} {} dbquit all
 Quit debugging mode immediately without further code execution.  With no
 arguments, exit the current debugging level.  With argument @code{all},
--- a/libinterp/corefcn/event-manager.cc	Tue Dec 10 12:19:09 2019 -0800
+++ b/libinterp/corefcn/event-manager.cc	Tue Dec 10 13:19:07 2019 -0800
@@ -596,7 +596,7 @@
            doc: /* -*- texinfo -*-
 @deftypefn {} {} commandhistory ()
 Show the GUI command history window and give it the keyboard focus.
-@seealso{commandwindow, filebrowser, workspace} 
+@seealso{commandwindow, filebrowser, workspace}
 @end deftypefn */)
 {
   if (args.length () != 0)
@@ -611,7 +611,7 @@
            doc: /* -*- texinfo -*-
 @deftypefn {} {} commandwindow ()
 Show the GUI command window and give it the keyboard focus.
-@seealso{commandhistory, filebrowser, workspace} 
+@seealso{commandhistory, filebrowser, workspace}
 @end deftypefn */)
 {
   if (args.length () != 0)
@@ -626,7 +626,7 @@
            doc: /* -*- texinfo -*-
 @deftypefn {} {} filebrowser ()
 Show the GUI file browser window and give it the keyboard focus.
-@seealso{commandwindow, commandhistory, workspace} 
+@seealso{commandwindow, commandhistory, workspace}
 @end deftypefn */)
 {
   if (args.length () != 0)
@@ -641,7 +641,7 @@
            doc: /* -*- texinfo -*-
 @deftypefn {} {} workspace ()
 Show the GUI workspace window and give it the keyboard focus.
-@seealso{commandwindow, commandhistory, filebrowser} 
+@seealso{commandwindow, commandhistory, filebrowser}
 @end deftypefn */)
 {
   if (args.length () != 0)
--- a/libinterp/corefcn/file-io.cc	Tue Dec 10 12:19:09 2019 -0800
+++ b/libinterp/corefcn/file-io.cc	Tue Dec 10 13:19:07 2019 -0800
@@ -489,7 +489,7 @@
 
 The first form of the @code{fopen} function opens the named file with
 the specified mode (read-write, read-only, etc.@:), architecture
-interpretation (IEEE big endian, IEEE little endian, etc.) and file encoding,
+interpretation (IEEE big endian, IEEE little endian, etc.@:) and file encoding,
 and returns an integer value that may be used to refer to the file later.  If
 an error occurs, @var{fid} is set to @minus{}1 and @var{msg} contains the
 corresponding system error message.  The @var{mode} is a one or two
--- a/libinterp/corefcn/stream-euler.cc	Tue Dec 10 12:19:09 2019 -0800
+++ b/libinterp/corefcn/stream-euler.cc	Tue Dec 10 13:19:07 2019 -0800
@@ -502,10 +502,10 @@
 
 DEFUN (streameuler2d, args, ,
        doc: /* -*- texinfo -*-
-@deftypefn  {} {} streameuler2d (@var{U}, @var{V}, @var{TX}, @var{TY}, @var{ZETA}, @var{XI}, @var{H}, @var{MAXNVERTS})
+@deftypefn {} {} streameuler2d (@var{U}, @var{V}, @var{TX}, @var{TY}, @var{ZETA}, @var{XI}, @var{H}, @var{MAXNVERTS})
 Calculates the streamline in a vector field [@var{U}, @var{V}] starting from a
-seed point at position [@var{ZETA}, @var{XI}]. The integrator used is
-Heun's Scheme. The step size can be controlled by @var{H}. The Jacobian
+seed point at position [@var{ZETA}, @var{XI}].  The integrator used is
+Heun's Scheme.  The step size can be controlled by @var{H}.  The Jacobian
 matrix can be defined for each grid cell by [@var{TX}, @var{TY}].
 
 @seealso{streamline, stream2, stream3, streameuler3d}
@@ -516,11 +516,12 @@
 
 DEFUN (streameuler3d, args, ,
        doc: /* -*- texinfo -*-
-@deftypefn  {} {} streameuler3d (@var{U}, @var{V}, @var{W}, @var{TX}, @var{TY}, @var{TZ}, @var{ZETA}, @var{XI}, @var{RHO}, @var{H}, @var{MAXNVERTS})
-Calculates the streamline in a vector field [@var{U}, @var{V}, @var{W}] starting
-from a seed point at position [@var{ZETA}, @var{XI}, @var{RHO}]. The integrator
-used is Heun's Scheme. The step size can be controlled by @var{H}. The Jacobian
-matrix can be defined for each grid cell by [@var{TX}, @var{TY}, @var{TZ}].
+@deftypefn {} {} streameuler3d (@var{U}, @var{V}, @var{W}, @var{TX}, @var{TY}, @var{TZ}, @var{ZETA}, @var{XI}, @var{RHO}, @var{H}, @var{MAXNVERTS})
+Calculates the streamline in a vector field [@var{U}, @var{V}, @var{W}]
+starting from a seed point at position [@var{ZETA}, @var{XI}, @var{RHO}].  The
+integrator used is Heun's Scheme.  The step size can be controlled by @var{H}.
+ The Jacobian matrix can be defined for each grid cell by [@var{TX}, @var{TY},
+@var{TZ}].
 
 @seealso{streamline, stream2, stream3, streameuler2d}
 @end deftypefn */)
--- a/libinterp/corefcn/strfns.cc	Tue Dec 10 12:19:09 2019 -0800
+++ b/libinterp/corefcn/strfns.cc	Tue Dec 10 13:19:07 2019 -0800
@@ -979,7 +979,8 @@
 DEFUN (__locale_charset__, , ,
        doc: /* -*- texinfo -*-
 @deftypefn {} {@var{charset} =} __locale_charset__ ()
-Return the identifier for the charset used if the encoding is set to "locale".
+Return the identifier for the charset used if the encoding is set to
+@qcode{"locale"}.
 @end deftypefn */)
 {
   const char *charset = octave_locale_charset_wrapper ();
--- a/libinterp/corefcn/urlwrite.cc	Tue Dec 10 12:19:09 2019 -0800
+++ b/libinterp/corefcn/urlwrite.cc	Tue Dec 10 13:19:07 2019 -0800
@@ -274,7 +274,7 @@
 
 DEFUN (__restful_service__, args, nargout,
        doc: /* -*- texinfo -*-
-@deftypefn  {} {@var{response} =} __restful_service__ (@var{url}, @var{param}, @var{weboptions})
+@deftypefn {} {@var{response} =} __restful_service__ (@var{url}, @var{param}, @var{weboptions})
 Undocumented internal function.
 @end deftypefn */)
 {
--- a/libinterp/dldfcn/dmperm.cc	Tue Dec 10 12:19:09 2019 -0800
+++ b/libinterp/dldfcn/dmperm.cc	Tue Dec 10 13:19:07 2019 -0800
@@ -134,7 +134,7 @@
 
 The method used is described in: @nospell{A. Pothen & C.-J. Fan.}
 @cite{Computing the Block Triangular Form of a Sparse Matrix}.
-@nospell{ACM} Trans. Math. Software, 16(4):303--324, 1990.
+@nospell{ACM} Trans.@: Math.@: Software, 16(4):303--324, 1990.
 @seealso{colamd, ccolamd}
 @end deftypefn */)
 {