Mercurial > hg > octave-jordi
changeset 20715:1ecee53513d7
doc: Peridodic grammar check of documentation.
* diffeq.txi, numbers.txi, symtab.cc, urlwrite.cc, mget.m, uicontextmenu.m,
uicontrol.m, uipanel.m, uipushtool.m, uitoggletool.m, uitoolbar.m, waitbar.m,
hsv2rgb.m, beep.m, textread.m, odeget.m, integrate_adaptive.m,
integrate_const.m, annotation.m, surfnorm.m:
Peridodic grammar check of documentation.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 18 Nov 2015 17:24:47 -0800 |
parents | 5b7643257978 |
children | d1cfc304665a |
files | doc/interpreter/diffeq.txi doc/interpreter/numbers.txi libinterp/corefcn/symtab.cc libinterp/corefcn/urlwrite.cc scripts/@ftp/mget.m scripts/gui/uicontextmenu.m scripts/gui/uicontrol.m scripts/gui/uipanel.m scripts/gui/uipushtool.m scripts/gui/uitoggletool.m scripts/gui/uitoolbar.m scripts/gui/waitbar.m scripts/image/hsv2rgb.m scripts/io/beep.m scripts/io/textread.m scripts/ode/odeget.m scripts/ode/private/integrate_adaptive.m scripts/ode/private/integrate_const.m scripts/plot/appearance/annotation.m scripts/plot/draw/surfnorm.m |
diffstat | 20 files changed, 88 insertions(+), 59 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/diffeq.txi +++ b/doc/interpreter/diffeq.txi @@ -123,21 +123,25 @@ @subsection Matlab-compatible solvers Octave also provides a set of solvers for initial value problems for Ordinary -Differential Equations that have a Matlab-compatible interface. +Differential Equations that have a @sc{matlab}-compatible interface. The options for this class of methods are set using the functions. + @itemize @item @code{odeset} + @item @code{odeget} @end itemize Currently implemented solvers are: + @itemize @item Runge-Kutta methods + @itemize @item @code{ode45} Integrates a system of non--stiff ordinary differential equations (non--stiff ODEs and DAEs) using second order Dormand-Prince method. This is a fourth--order accurate integrator therefore the local error - normally expected is @math{O(h^5)}. This solver requires six function + normally expected is @math{O(h^5)}. This solver requires six function evaluations per integration step. @end itemize @end itemize
--- a/doc/interpreter/numbers.txi +++ b/doc/interpreter/numbers.txi @@ -619,7 +619,8 @@ As the maximum value that can be represented by a number is important for bit manipulation, particularly when forming masks, Octave supplies -two functions 'flintmax' for floating point integers, and 'intmax'. +two utility functions: @code{flintmax} for floating point integers, and +@code{intmax} for integer objects (@code{uint8}, @code{int64}, etc.). Octave also includes the basic bitwise 'and', 'or', and 'exclusive or' operators.
--- a/libinterp/corefcn/symtab.cc +++ b/libinterp/corefcn/symtab.cc @@ -1808,7 +1808,7 @@ DEFUN (__get_cmdline_fcn_txt__, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} __get_cmdline_fcn_txt__ (@var{name})\n\ +@deftypefn {Built-in Function} {} __get_cmdline_fcn_txt__ (@var{name})\n\ Undocumented internal function.\n\ @end deftypefn") {
--- a/libinterp/corefcn/urlwrite.cc +++ b/libinterp/corefcn/urlwrite.cc @@ -1006,7 +1006,7 @@ DEFUN (__ftp_mget__, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} __ftp_mget__ (@var{handle}, @var{pattern})\n\ +@deftypefn {Loadable Function} {} __ftp_mget__ (@var{handle}, @var{pattern})\n\ @deftypefnx {Loadable Function} {} __ftp_mget__ (@var{handle}, @var{pattern}, @var{target})\n\ Undocumented internal function\n\ @end deftypefn")
--- a/scripts/@ftp/mget.m +++ b/scripts/@ftp/mget.m @@ -29,7 +29,7 @@ ## files or directories on the remote server that match will be downloaded. ## ## If a third string argument @var{target} is given, then it must indicate -## the path to the local destination directory. @var{target} may be a +## the path to the local destination directory. @var{target} may be a ## relative or absolute path. ## @end deftypefn
--- a/scripts/gui/uicontextmenu.m +++ b/scripts/gui/uicontextmenu.m @@ -17,18 +17,18 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{hui} =} uicontextmenu (@var{property}, @var{value}, @dots{}) +## @deftypefn {Function File} {@var{hui} =} uicontextmenu (@var{property}, @var{value}, @dots{}) ## @deftypefnx {Function File} {@var{hui} =} uicontextmenu (@var{h}, @var{property}, @var{value}, @dots{}) ## ## Create a uicontextmenu object and return a handle to it. ## ## If @var{h} is omitted then a uicontextmenu for the current figure is -## created. If no figure is available, a new figure is created first. +## created. If no figure is available, a new figure is created first. ## ## If @var{h} is given then a uicontextmenu relative to @var{h} is created. ## -## Any provided property value pairs will override the default values of the created -## uicontextmenu object. +## Any provided property value pairs will override the default values of the +## created uicontextmenu object. ## ## Uicontextmenu propertes are documented at @ref{Uicontextmenu Properties}. ##
--- a/scripts/gui/uicontrol.m +++ b/scripts/gui/uicontrol.m @@ -23,20 +23,23 @@ ## ## Create a uicontrol object and return a handle to it. ## -## uicontrols are used to create simple interactive controls such as push buttons, checkboxes, edit and list controls. +## uicontrols are used to create simple interactive controls such as push +## buttons, checkboxes, edit and list controls. ## ## If @var{parent} is omitted then a uicontrol for the current figure is -## created. If no figure is available, a new figure is created first. +## created. If no figure is available, a new figure is created first. ## -## If @var{parent} is given then a uicontrol relative to @var{parent} is created. +## If @var{parent} is given then a uicontrol relative to @var{parent} is +## created. ## -## Any provided property value pairs will override the default values of the created -## uicontrol object. +## Any provided property value pairs will override the default values of the +## created uicontrol object. ## ## Uicontrol propertes are documented at @ref{Uicontrol Properties}. ## -## Control of the type of uicontrol created is through the use of the @var{style} property. -## If no style property is provided, a push button will be created. +## Control of the type of uicontrol created is through the use of the +## @var{style} property. If no style property is provided, a push button will +## be created. ## ## Valid styles for uicontrol are: ## @@ -45,33 +48,34 @@ ## Create a checkbox control that allows user on/off selection. ## ## @item @qcode{"edit"} -## Create a edit control that allows user input of single or multiple lines of text. +## Create an edit control that allows user input of single or multiple lines +## of text. ## ## @item @qcode{"listbox"} -## Create a listbox control that displays a lit of items and allows user slelection of -## single or multiple items. +## Create a listbox control that displays a lit of items and allows user +## slelection of single or multiple items. ## ## @item @qcode{"popupmenu"} -## Create a popupmenu control that displays a list of options that can be selected -## when the user clicks on the control. +## Create a popupmenu control that displays a list of options that can be +## selected when the user clicks on the control. ## ## @item @qcode{"pushbutton"} ## Create a push button control that allows user to press to cause an action. ## ## @item @qcode{"radiobutton"} -## Create a radio button control intended to be used for mutually exclusive input in a group of -## of radiobutton controls. +## Create a radio button control intended to be used for mutually exclusive +## input in a group of radiobutton controls. ## ## @item @qcode{"slider"} -## Create a slider control that allows user selection from a range of values by sliding -## knob on the control. +## Create a slider control that allows user selection from a range of values +## by sliding knob on the control. ## ## @item @qcode{"text"} ## Create a static text control to display single or multiple lines of text. ## ## @item @qcode{"togglebutton"} -## Create a toggle button control that appears like a push button but allows the user to -## select between two states. +## Create a toggle button control that appears like a push button but allows +## the user to select between two states. ## ## @end table ##
--- a/scripts/gui/uipanel.m +++ b/scripts/gui/uipanel.m @@ -25,12 +25,12 @@ ## uipanels are used as containers to group other uicontrol objects. ## ## If @var{parent} is omitted then a uipanel for the current figure is -## created. If no figure is available, a new figure is created first. +## created. If no figure is available, a new figure is created first. ## ## If @var{parent} is given then a uipanel relative to @var{parent} is created. ## -## Any provided property value pairs will override the default values of the created -## uipanel object. +## Any provided property value pairs will override the default values of the +## created uipanel object. ## ## Uipanel propertes are documented at @ref{Uipanel Properties}. ##
--- a/scripts/gui/uipushtool.m +++ b/scripts/gui/uipushtool.m @@ -22,17 +22,20 @@ ## ## Create a uipushtool object and return a handle to it. ## -## uipushtools are buttons that appear on a figure toolbar. The button is created with a border that -## is shown when the user hovers over the button. An image can be set using the cdata property. +## uipushtools are buttons that appear on a figure toolbar. The button is +## created with a border that is shown when the user hovers over the button. +## An image can be set using the cdata property. ## ## If @var{parent} is omitted then a uipushtool for the current figure is -## created. If no figure is available, a new figure is created first. If a figure is -## available, but does not contain a uitoolbar, a uitoolbar will be created. +## created. If no figure is available, a new figure is created first. If a +## figure is available, but does not contain a uitoolbar, a uitoolbar will be +## created. ## -## If @var{parent} is given then a uipushtools is created on the @var{parent} uitoolbar. +## If @var{parent} is given then an uipushtools is created on the +## @var{parent} uitoolbar. ## -## Any provided property value pairs will override the default values of the created -## uipushtool object. +## Any provided property value pairs will override the default values of the +## created uipushtool object. ## ## Uipushtool propertes are documented at @ref{Uipushtool Properties}. ##
--- a/scripts/gui/uitoggletool.m +++ b/scripts/gui/uitoggletool.m @@ -22,17 +22,20 @@ ## ## Create a uitoggletool object and return a handle to it. ## -## uitoggletool are togglebuttons that appear on a figure toolbar. The button is created with a border that -## is shown when the user hovers over the button. An image can be set using the cdata property. +## uitoggletool are togglebuttons that appear on a figure toolbar. The +## button is created with a border that is shown when the user hovers over +## the button. An image can be set using the cdata property. ## ## If @var{parent} is omitted then a uitoggletool for the current figure is -## created. If no figure is available, a new figure is created first. If a figure is -## available, but does not contain a uitoolbar, a uitoolbar will be created. +## created. If no figure is available, a new figure is created first. If a +## figure is available, but does not contain a uitoolbar, a uitoolbar will be +## created. ## -## If @var{parent} is given then a uitoggletool is created on the @var{parent} uitoolbar. +## If @var{parent} is given then a uitoggletool is created on the +## @var{parent} uitoolbar. ## -## Any provided property value pairs will override the default values of the created -## uitoggletool object. +## Any provided property value pairs will override the default values of the +## created uitoggletool object. ## ## Uitoggletool propertes are documented at @ref{Uitoggletool Properties}. ##
--- a/scripts/gui/uitoolbar.m +++ b/scripts/gui/uitoolbar.m @@ -20,15 +20,17 @@ ## @deftypefn {Function File} {@var{hui} =} uitoolbar (@var{property}, @var{value}, @dots{}) ## @deftypefnx {Function File} {@var{hui} =} uitoolbar (@var{parent}, @var{property}, @var{value}, @dots{}) ## -## Create a uitoolbar object and return a handle to it. A uitoolbar displays uitoggletool and uipushtool buttons. +## Create a uitoolbar object and return a handle to it. A uitoolbar displays +## uitoggletool and uipushtool buttons. ## ## If @var{parent} is omitted then a uitoolbar for the current figure is -## created. If no figure is available, a new figure is created first. +## created. If no figure is available, a new figure is created first. ## -## If @var{parent} is given then a uitoolbar relative to @var{parent} is created. +## If @var{parent} is given then a uitoolbar relative to @var{parent} is +## created. ## -## Any provided property value pairs will override the default values of the created -## uitoolbar object. +## Any provided property value pairs will override the default values of the +## created uitoolbar object. ## ## Uitoolbar propertes are documented at @ref{Uitoolbar Properties}. ##
--- a/scripts/gui/waitbar.m +++ b/scripts/gui/waitbar.m @@ -32,7 +32,7 @@ ## The optional message @var{msg} is centered and displayed above the waitbar. ## ## A cancel button can be added to the bottom of the waitbar using the -## "createcancelbtn" property of waitbar figures. The action to be +## @qcode{"createcancelbtn"} property of waitbar figures. The action to be ## executed when the user presses the button is specified using a string or ## function handle @var{fcn}. ##
--- a/scripts/image/hsv2rgb.m +++ b/scripts/image/hsv2rgb.m @@ -34,6 +34,7 @@ ## @code{mod (h, 1)} is used. ## ## @example +## @group ## >> hsv2rgb ([0.5 1 1]) ## @result{} ans = 0 1 1 ## @@ -42,6 +43,7 @@ ## ## >> hsv2rgb ([3.5 1 1]) ## @result{} ans = 0 1 1 +## @end group ## @end example ## ## Output class and size will be the same as input.
--- a/scripts/io/beep.m +++ b/scripts/io/beep.m @@ -21,7 +21,7 @@ ## Produce a beep from the speaker (or visual bell). ## ## This function sends the alarm character @qcode{"@xbackslashchar{}a"} to -## the terminal. Depending on the user's configuration this may produce an +## the terminal. Depending on the user's configuration this may produce an ## audible beep, a visual bell, or nothing at all. ## @seealso{puts, fputs, printf, fprintf} ## @end deftypefn
--- a/scripts/io/textread.m +++ b/scripts/io/textread.m @@ -58,21 +58,26 @@ ## Examples: ## ## @example +## @group ## Assume a data file like: ## 1 a 2 b ## 3 c 4 d ## 5 e +## @end group ## @end example ## ## @example +## @group ## [a, b] = textread (f, "%f %s") ## returns two columns of data, one with doubles, the other a ## cellstr array: ## a = [1; 2; 3; 4; 5] ## b = @{"a"; "b"; "c"; "d"; "e"@} +## @end group ## @end example ## ## @example +## @group ## [a, b] = textread (f, "%f %s", 3) ## (read data into two culumns, try to use the format string ## three times) @@ -80,9 +85,11 @@ ## a = [1; 2; 3] ## b = @{"a"; "b"; "c"@} ## +## @end group ## @end example ## ## @example +## @group ## With a data file like: ## 1 ## a @@ -92,9 +99,10 @@ ## [a, b] = textread (f, "%f %s", 2) ## returns a = 1 and b = @{"a"@}; i.e., the format string is used ## only once because the format string refers to 2 lines of the -## data file. To obtain 2x1 data output columns, specify N = 4 +## data file. To obtain 2x1 data output columns, specify N = 4 ## (number of data lines containing all requested data) rather ## than 2. +## @end group ## @end example ## ## @seealso{strread, load, dlmread, fscanf, textscan}
--- a/scripts/ode/odeget.m +++ b/scripts/ode/odeget.m @@ -27,9 +27,9 @@ ## If called with two input arguments and the first input argument @var{ode_opt} ## is an ODE option structure and the second input argument @var{field} is a ## string specifying an option name, then return the option value @var{val} -## corresponding to to @var{field} from @var{ode_opt}. +## corresponding to @var{field} from @var{ode_opt}. ## -## If called called with an optional third input argument, and @var{field} is +## If called with an optional third input argument, and @var{field} is ## not set in the structure @var{ode_opt}, then return the default value ## @var{default} instead. ## @seealso{odeset}
--- a/scripts/ode/private/integrate_adaptive.m +++ b/scripts/ode/private/integrate_adaptive.m @@ -51,7 +51,7 @@ ## @end ifnothtml ## ## The fourth input argument is the time vector which defines the integration -## interval, i.e, @var{[tspan(1), tspan(end)]} and all intermediate elements +## interval, i.e., @var{[tspan(1), tspan(end)]} and all intermediate elements ## are taken as times at which the solution is required. ## ## The fifth argument represents the initial conditions for the ODEs and the
--- a/scripts/ode/private/integrate_const.m +++ b/scripts/ode/private/integrate_const.m @@ -50,7 +50,7 @@ ## @end ifnothtml ## ## The fourth input argument is the time vector which defines the integration -## interval, i.e, @var{[tspan(1), tspan(end)]} and all intermediate elements +## interval, i.e., @var{[tspan(1), tspan(end)]} and all intermediate elements ## are taken as times at which the solution is required. ## ## The fourth argument contains the initial conditions for the ODEs.
--- a/scripts/plot/appearance/annotation.m +++ b/scripts/plot/appearance/annotation.m @@ -100,7 +100,7 @@ ## @item @qcode{"textarrow"} ## Construct an arrow with a text label at the opposite end from the arrowhead. ## -## Use the "string" property to change the text string. +## Use the @qcode{"string"} property to change the text string. ## 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, that some text property names are prefixed with @@ -113,7 +113,7 @@ ## Construct a box with text inside. @var{pos} specifies the ## @qcode{"position"} property of the annotation. ## -## Use the "string" property to change the text string. +## Use the @qcode{"string"} property to change the text string. ## You may use @qcode{"backgroundcolor"}, @qcode{"edgecolor"}, ## @qcode{"linestyle"}, and @qcode{"linewidth"} properties to customize ## the box background color and edge appearance. A limited set of @code{text}