# HG changeset patch # User Rik # Date 1669776056 28800 # Node ID a3d8915b9f87b857cf0c6d5df9fd7518a30693db # Parent 0f93c3a756f7590b5446b9681ec5ed52fb30ce37 doc: more DOCSTRING changes ahead of 8.1 release. * ordschur.cc, stream-euler.cc, ov-class.cc, ov-classdef.cc, uigetfile.m, uiputfile.m, memory.m, compare_plot_demos.m, html_compare_plot_demos.m: More DOCSTRING changes ahead of 8.1 release. diff -r 0f93c3a756f7 -r a3d8915b9f87 libinterp/corefcn/ordschur.cc --- a/libinterp/corefcn/ordschur.cc Tue Nov 29 15:58:49 2022 -0800 +++ b/libinterp/corefcn/ordschur.cc Tue Nov 29 18:40:56 2022 -0800 @@ -37,7 +37,7 @@ DEFUN (ordschur, args, , doc: /* -*- texinfo -*- @deftypefn {} {[@var{UR}, @var{SR}] =} ordschur (@var{U}, @var{S}, @var{select}) -Reorders the real Schur factorization (@var{U},@var{S}) obtained with the +Reorder the real Schur factorization (@var{U},@var{S}) obtained with the @code{schur} function, so that selected eigenvalues appear in the upper left diagonal blocks of the quasi triangular Schur matrix. diff -r 0f93c3a756f7 -r a3d8915b9f87 libinterp/corefcn/stream-euler.cc --- a/libinterp/corefcn/stream-euler.cc Tue Nov 29 15:58:49 2022 -0800 +++ b/libinterp/corefcn/stream-euler.cc Tue Nov 29 18:40:56 2022 -0800 @@ -507,7 +507,7 @@ DEFUN (__streameuler2d__, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{output} =} __streameuler2d__ (@var{U}, @var{V}, @var{TX}, @var{TY}, @var{ZETA}, @var{XI}, @var{H}, @var{MAXNVERTS}) -Calculates the streamline in a vector field @code{[@var{U}, @var{V}]} starting +Calculate the streamline in a vector field @code{[@var{U}, @var{V}]} starting from a seed point at position @code{[@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 @@ -522,7 +522,7 @@ DEFUN (__streameuler3d__, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{output} =} __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 @code{[@var{U}, @var{V}, @var{W}]} +Calculate the streamline in a vector field @code{[@var{U}, @var{V}, @var{W}]} starting from a seed point at position @code{[@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 diff -r 0f93c3a756f7 -r a3d8915b9f87 libinterp/octave-value/ov-class.cc --- a/libinterp/octave-value/ov-class.cc Tue Nov 29 15:58:49 2022 -0800 +++ b/libinterp/octave-value/ov-class.cc Tue Nov 29 18:40:56 2022 -0800 @@ -2139,7 +2139,7 @@ DEFUN (__inline_ctor__, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{inline_obj} =} __inline_ctor__ (@var{prop_struct}) -Implements final construction for inline objects. +Implement final construction for inline objects. @end deftypefn */) { // Input validation has already been done in input.m. diff -r 0f93c3a756f7 -r a3d8915b9f87 libinterp/octave-value/ov-classdef.cc --- a/libinterp/octave-value/ov-classdef.cc Tue Nov 29 15:58:49 2022 -0800 +++ b/libinterp/octave-value/ov-classdef.cc Tue Nov 29 18:40:56 2022 -0800 @@ -618,7 +618,7 @@ DEFUN (metaclass, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{metaclass_obj} =} metaclass (obj) -Returns the meta.class object corresponding to the class of @var{obj}. +Return the meta.class object corresponding to the class of @var{obj}. @end deftypefn */) { if (args.length () != 1) @@ -724,7 +724,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{mtds} =} __methods__ (@var{obj}) @deftypefnx {} {@var{mtds} =} __methods__ ("classname") -Implements @code{methods} for Octave class objects and classnames. +Implement @code{methods} for Octave class objects and classnames. @seealso{methods} @end deftypefn */) { diff -r 0f93c3a756f7 -r a3d8915b9f87 scripts/gui/uigetfile.m --- a/scripts/gui/uigetfile.m Tue Nov 29 15:58:49 2022 -0800 +++ b/scripts/gui/uigetfile.m Tue Nov 29 18:40:56 2022 -0800 @@ -48,14 +48,12 @@ ## ## @item A 2-column cell array ## containing a file extension in the first column and a brief description in -## the second column. -## Example: @code{uigetfile (@{"*.ext", "My Description";"*.xyz", -## "XYZ-Format"@})} +## the second column. Example: +## @code{uigetfile (@{"*.ext", "My Description";"*.xyz", "XYZ-Format"@})} ## ## The filter string can also contain a semicolon separated list of filter -## extensions. -## Example: @code{uigetfile (@{"*.gif;*.png;*.jpg", "Supported Picture -## Formats"@})} +## extensions. Example: +## @code{uigetfile (@{"*.gif;*.png;*.jpg", "Supported Picture Formats"@})} ## ## @item A directory name or path name ## If the folder name of path name contains a trailing file separator, the diff -r 0f93c3a756f7 -r a3d8915b9f87 scripts/gui/uiputfile.m --- a/scripts/gui/uiputfile.m Tue Nov 29 15:58:49 2022 -0800 +++ b/scripts/gui/uiputfile.m Tue Nov 29 18:40:56 2022 -0800 @@ -46,15 +46,13 @@ ## ## @item @code{@{"*.ext", "My Description"@}} ## A 2-column cell array containing the file extension in the 1st column and -## a brief description in the 2nd column. -## Example: @code{uiputfile (@{"*.ext","My Description";"*.xyz", -## "XYZ-Format"@})} +## a brief description in the 2nd column. Example: +## @code{uiputfile (@{"*.ext","My Description";"*.xyz", "XYZ-Format"@})} ## @end table ## ## The filter string can also contain a semicolon separated list of filter -## extensions. -## Example: @code{uiputfile (@{"*.gif;*.png;*.jpg", -## "Supported Picture Formats"@})} +## extensions. Example: +## @code{uiputfile (@{"*.gif;*.png;*.jpg", "Supported Picture Formats"@})} ## ## @var{dialog_name} can be used to customize the dialog title. ## If @var{default_file} is given it is preselected in the GUI dialog. diff -r 0f93c3a756f7 -r a3d8915b9f87 scripts/miscellaneous/memory.m --- a/scripts/miscellaneous/memory.m Tue Nov 29 15:58:49 2022 -0800 +++ b/scripts/miscellaneous/memory.m Tue Nov 29 18:40:56 2022 -0800 @@ -103,7 +103,6 @@ ## Example #2 : return structs with memory usage information ## ## @example -## @group ## [userdata, systemdata] = memory () ## @result{} ## userdata = @@ -141,7 +140,6 @@ ## ## Available = 2.8147e+14 ## Total = 2.8147e+14 -## @end group ## @end example ## ## Programming Note: This function is implemented for Linux and Windows only. diff -r 0f93c3a756f7 -r a3d8915b9f87 scripts/testfun/private/compare_plot_demos.m --- a/scripts/testfun/private/compare_plot_demos.m Tue Nov 29 15:58:49 2022 -0800 +++ b/scripts/testfun/private/compare_plot_demos.m Tue Nov 29 18:40:56 2022 -0800 @@ -27,7 +27,7 @@ ## @deftypefn {} {} compare_plot_demos () ## @deftypefnx {} {} compare_plot_demos ("toolkits", @{@var{toolkit1}, @var{toolkit2}, @dots{}@}) ## -## Uses @code{dump_demos} and @code{html_compare_plot_demos} to produce an +## Use @code{dump_demos} and @code{html_compare_plot_demos} to produce an ## html comparison of the plot demos for each of Octave's graphics toolkits. ## ## An m-file named @file{dump_plots.m} will be created in the current working diff -r 0f93c3a756f7 -r a3d8915b9f87 scripts/testfun/private/html_compare_plot_demos.m --- a/scripts/testfun/private/html_compare_plot_demos.m Tue Nov 29 15:58:49 2022 -0800 +++ b/scripts/testfun/private/html_compare_plot_demos.m Tue Nov 29 18:40:56 2022 -0800 @@ -27,7 +27,7 @@ ## @deftypefn {} {} html_compare (@var{toolkits}) ## @deftypefnx {} {} html_compare (@var{toolkits}, @var{name}, @var{value}, @dots{}) ## -## Produces an html document to compare the plot demos produced by +## Produce an html document to compare the plot demos produced by ## @var{toolkits}. ## ## Valid property names, and their defaults, are: