Mercurial > octave
changeset 22299:9fc91bb2aec3
doc: grammarcheck documentation for 4.2 release.
* container.txi, contrib.txi, diagperm.txi, errors.txi, external.txi,
func.txi, image.txi, nonlin.txi, numbers.txi, plot.txi, quad.txi, sparse.txi,
strings.txi, tips.txi, var.txi, vectorize.txi, __dispatch__.cc, cellfun.cc,
file-io.cc, gsvd.cc, load-path.cc, regexp.cc, __init_gnuplot__.cc,
__osmesa_print__.cc, qr.cc, xzip.cc, ov-classdef.cc, octave_config_info.m,
grabcode.m, publish.m, dialog.m, condest.m, normest1.m, mkdir.m, ode23.m,
ode45.m, odeplot.m, AbsRel_Norm.m, integrate_adaptive.m, integrate_const.m,
integrate_n_steps.m, axis.m, isocaps.m, isocolors.m, isosurface.m, light.m,
__calc_isovalue_from_data__.m, __marching_cube__.m, cov.m, median.m:
doc: grammarcheck documentation for 4.2 release.
line wrap: on
line diff
--- a/doc/interpreter/container.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/container.txi Mon Aug 15 10:05:50 2016 -0700 @@ -834,8 +834,9 @@ @end example The indexing operations operate on the cell array and not on the objects -within the cell array. By contrast, @code{cellindexmat} applies matrix indexing -to the objects within each cell array entry and returns the requested values. +within the cell array. By contrast, @code{cellindexmat} applies matrix +indexing to the objects within each cell array entry and returns the requested +values. @DOCSTRING(cellindexmat)
--- a/doc/interpreter/contrib.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/contrib.txi Mon Aug 15 10:05:50 2016 -0700 @@ -317,16 +317,20 @@ distinguish between columns. @example +@group M = [1, 2, 3 4, 5, 6]; +@end group @end example However, if the matrix is large or the indentation makes it clear the comma may be dropped. @example +@group prices = [ 1.01 2.02 3.03 44.04 55.05 6.06]; +@end group @end example Use lowercase names if possible. Uppercase is acceptable for variable @@ -398,8 +402,8 @@ after control structures (like @code{if}, @code{while}, etc.). If there is a compound statement, indent @emph{both} the curly braces and the body of the statement (so that the body gets indented by @emph{two} -indents). This format is known as "GNU style" and is an option for some -code formatting tools. Example indenting: +indents). This format is known as @nospell{"GNU style"} and is an option for +some code formatting tools. Example indenting: @example @group @@ -467,7 +471,7 @@ number of @code{return} statements, but elimination of all but one @code{return} is not required. -When an empty string is required, use @code{""}, rather than creating an empty +When an empty string is required, use @qcode{""}, rather than creating an empty string object with @code{std::string ()}. @node Other Sources
--- a/doc/interpreter/diagperm.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/diagperm.txi Mon Aug 15 10:05:50 2016 -0700 @@ -40,9 +40,9 @@ @ifnottex @code{D(i,j) == 0} if @code{i != j}. @end ifnottex -Most often, square diagonal matrices are considered; however, the definition can -equally be applied to non-square matrices, in which case we usually speak of a -rectangular diagonal matrix. +Most often, square diagonal matrices are considered; however, the definition +can equally be applied to non-square matrices, in which case we usually speak +of a rectangular diagonal matrix. A permutation matrix is defined as a square matrix that has a single element equal to unity in each row and each column; all other elements are zero. That @@ -94,8 +94,8 @@ vector, will create a square diagonal matrix with elements on the main diagonal given by the elements of @var{v}, and size equal to the length of @var{v}. @code{diag (v, m, n)} can be used to construct a rectangular diagonal matrix. -The result of these expressions will be a special diagonal matrix object, rather -than a general matrix object. +The result of these expressions will be a special diagonal matrix object, +rather than a general matrix object. Diagonal matrix with unit elements can be created using @dfn{eye}. Some other built-in functions can also return diagonal matrices. Examples @@ -129,9 +129,9 @@ @node Creating Permutation Matrices @subsection Creating Permutation Matrices -For creating permutation matrices, Octave does not introduce a new function, but -rather overrides an existing syntax: permutation matrices can be conveniently -created by indexing an identity matrix by permutation vectors. +For creating permutation matrices, Octave does not introduce a new function, +but rather overrides an existing syntax: permutation matrices can be +conveniently created by indexing an identity matrix by permutation vectors. That is, if @var{q} is a permutation vector of length @var{n}, the expression @example @@ -210,10 +210,10 @@ @node Explicit and Implicit Conversions @subsection Explicit and Implicit Conversions -The diagonal and permutation matrices are special objects in their own right. A -number of operations and built-in functions are defined for these matrices to -use special, more efficient code than would be used for a full matrix in the -same place. Examples are given in further sections. +The diagonal and permutation matrices are special objects in their own right. +A number of operations and built-in functions are defined for these matrices +to use special, more efficient code than would be used for a full matrix in +the same place. Examples are given in further sections. To facilitate smooth mixing with full matrices, backward compatibility, and compatibility with @sc{matlab}, the diagonal and permutation matrices should @@ -341,10 +341,10 @@ is an efficient method of augmenting the diagonal of a matrix. Subtraction works analogically. -When involved in expressions with other element-by-element operators, @code{.*}, -@code{./}, @code{.\} or @code{.^}, an implicit conversion to full matrix will -take place. This is not always strictly necessary but chosen to facilitate -better consistency with @sc{matlab}. +When involved in expressions with other element-by-element operators, +@code{.*}, @code{./}, @code{.\} or @code{.^}, an implicit conversion to full +matrix will take place. This is not always strictly necessary but chosen to +facilitate better consistency with @sc{matlab}. @node Expressions Involving Permutation Matrices @subsection Expressions Involving Permutation Matrices @@ -352,7 +352,8 @@ If @var{P} is a permutation matrix and @var{M} a matrix, the expression @code{P*M} will permute the rows of @var{M}. Similarly, @code{M*P} will yield a column permutation. -Matrix division @code{P\M} and @code{M/P} can be used to do inverse permutation. +Matrix division @code{P\M} and @code{M/P} can be used to do inverse +permutation. The previously described syntax for creating permutation matrices can actually help an user to understand the connection between a permutation matrix and @@ -382,9 +383,9 @@ Multiplication and division by permutation matrices works efficiently also when combined with sparse matrices, i.e., @code{P*S}, where @var{P} is a permutation -matrix and @var{S} is a sparse matrix permutes the rows of the sparse matrix and -returns a sparse matrix. The expressions @code{S*P}, @code{P\S}, @code{S/P} -work analogically. +matrix and @var{S} is a sparse matrix permutes the rows of the sparse matrix +and returns a sparse matrix. The expressions @code{S*P}, @code{P\S}, +@code{S/P} work analogically. Two permutation matrices can be multiplied or divided (if their sizes match), performing a composition of permutations. Also a permutation matrix can be @@ -513,14 +514,15 @@ The IEEE floating point standard defines the result of the expressions @code{0*Inf} and @code{0*NaN} as @code{NaN}. This is widely agreed to be a -good compromise. Numerical software dealing with structured and sparse matrices -(including Octave) however, almost always makes a distinction between a -"numerical zero" and an "assumed zero". A "numerical zero" is a zero value -occurring in a place where any floating-point value could occur. It is -normally stored somewhere in memory as an explicit value. An "assumed zero", on -the contrary, is a zero matrix element implied by the matrix structure -(diagonal, triangular) or a sparsity pattern; its value is usually not stored -explicitly anywhere, but is implied by the underlying data structure. +good compromise. Numerical software dealing with structured and sparse +matrices (including Octave) however, almost always makes a distinction between +a @nospell{"numerical zero"} and an @nospell{"assumed zero"}. A +@nospell{"numerical zero"} is a zero value occurring in a place where any +floating-point value could occur. It is normally stored somewhere in memory +as an explicit value. An @nospell{"assumed zero"}, on the contrary, is a zero +matrix element implied by the matrix structure (diagonal, triangular) or a +sparsity pattern; its value is usually not stored explicitly anywhere, but is +implied by the underlying data structure. The primary distinction is that an assumed zero, when multiplied by any number, or divided by any nonzero number,
--- a/doc/interpreter/errors.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/errors.txi Mon Aug 15 10:05:50 2016 -0700 @@ -79,8 +79,8 @@ simply call @code{error} with two string arguments, where the first is the identification string, and the second is the actual error. Note that error IDs are in the format @qcode{"NAMESPACE:ERROR-NAME"}. The namespace -@qcode{"Octave"} is used for Octave's own errors. Any other string is available -as a namespace for user's own errors. +@qcode{"Octave"} is used for Octave's own errors. Any other string is +available as a namespace for user's own errors. @DOCSTRING(error)
--- a/doc/interpreter/external.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/external.txi Mon Aug 15 10:05:50 2016 -0700 @@ -46,9 +46,9 @@ shifting the focus from solving the real problem to solving a computer programming problem. It means returning to low-level constructs such as pointers, memory management, mathematical overflow/underflow, etc. Because -of the low level nature, and the fact that the compiled code is executed outside -of Octave, there is the very real possibility of crashing the interpreter and -losing work. +of the low level nature, and the fact that the compiled code is executed +outside of Octave, there is the very real possibility of crashing the +interpreter and losing work. Before going further, you should first determine if you really need to bother writing code outside of Octave. @@ -1316,9 +1316,9 @@ The first line @code{#include "mex.h"} makes available all of the definitions necessary for a mex-file. One important difference between Octave and @sc{matlab} is that the header file @qcode{"matrix.h"} is implicitly included -through the inclusion of @qcode{"mex.h"}. This is necessary to avoid a conflict -with the Octave file @qcode{"Matrix.h"} for operating systems and compilers that -don't distinguish between filenames in upper and lower case. +through the inclusion of @qcode{"mex.h"}. This is necessary to avoid a +conflict with the Octave file @qcode{"Matrix.h"} for operating systems and +compilers that don't distinguish between filenames in upper and lower case. The entry point into the mex-file is defined by @code{mexFunction}. The function takes four arguments: @@ -2034,7 +2034,7 @@ @item Next, Octave searches in the user's home directory. If a file @file{javaclasspath.txt} exists here, its contents are appended to the static classpath (if any). Thus, it is possible to build an initial static classpath -on a 'per user' basis. +on a @nospell{'per user'} basis. @item Finally, Octave looks for a next occurrence of file @file{javaclasspath.txt} in the m-files directory where Octave Java functions
--- a/doc/interpreter/func.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/func.txi Mon Aug 15 10:05:50 2016 -0700 @@ -23,10 +23,10 @@ @cindex functions, user-defined @cindex script files -Complicated Octave programs can often be simplified by defining -functions. Functions can be defined directly on the command line during -interactive Octave sessions, or in external files, and can be called just -like built-in functions. +Complicated Octave programs can often be simplified by defining functions. +Functions can be defined directly on the command line during interactive +Octave sessions, or in external files, and can be called just like built-in +functions. @menu * Introduction to Function and Script Files:: @@ -944,9 +944,9 @@ @var{x} in @code{bat} refers to the @var{x} in @code{foo}. Variable inheritance leads to a problem for @code{eval} and scripts. If a -new variable is created in a parent function, it is not clear what should happen -in nested child functions. For example, consider a parent function @code{foo} -with a nested child function @code{bar}: +new variable is created in a parent function, it is not clear what should +happen in nested child functions. For example, consider a parent function +@code{foo} with a nested child function @code{bar}: @example @group @@ -1309,13 +1309,13 @@ @subsubsection Using Publishing Markup in script files To use Publishing Markup, start by typing @samp{##} or @samp{%%} at the -beginning of a new line. For Matlab compatibility @samp{%%} is treated the -same way as @samp{%%}. +beginning of a new line. For @sc{matlab} compatibility @samp{%%} is treated +the same way as @samp{##}. -The lines following @samp{##} or @samp{%%} start with only one of either +The lines following @samp{##} or @samp{%%} start with one of either @samp{#} or @samp{%} followed by at least one space. These lines are -interpreted as section. A section ends with the first line not starting -with @samp{#} or @samp{%} or the end of the document is reached. +interpreted as section. A section ends at the first line not starting +with @samp{#} or @samp{%}, or when the end of the document is reached. A section starting in the first line of the document, followed by another start of a section that might be empty, is interpreted as a document @@ -1374,7 +1374,7 @@ a new line. A section title can be provided by writing it, separated by a space, in the first line after @samp{##} or @samp{%%}. Without a section title, the section is interpreted as a continuation of the previous section. -For Matlab compatibility @samp{%%} is treated the same way as @samp{%%}. +For @sc{matlab} compatibility @samp{%%} is treated the same way as @samp{%%}. @example @group @@ -1435,7 +1435,7 @@ # Whether 'tis nobler in the mind to suffer # The slings and arrows of outrageous fortune, # Or to take arms against a sea of troubles, -# And by opposing end them? To die: to sleep;" +# And by opposing end them? To die: to sleep;" # # --"Hamlet" by W. Shakespeare @end group @@ -1456,10 +1456,12 @@ @end group @end example +@noindent to get output like @itemize @bullet @item Bulleted list item 1 + @item Bulleted list item 2 @end itemize @@ -1481,10 +1483,12 @@ @end group @end example +@noindent to get output like @enumerate @item Numbered list item 1 + @item Numbered list item 2 @end enumerate @@ -1494,7 +1498,7 @@ @node Including file content @subsubsection Including file content -To include the content of an external file, e.g. a file called +To include the content of an external file, e.g., a file called @samp{my_function.m} at the same location as the published Octave script, use the following syntax to include it with Octave syntax highlighting. @@ -1516,7 +1520,7 @@ @node Including graphics @subsubsection Including graphics -To include external graphics, e.g. a graphic called @samp{my_graphic.png} +To include external graphics, e.g., a graphic called @samp{my_graphic.png} at the same location as the published Octave script, use the following syntax. Alternatively, you can write the full path to the graphic. @@ -1571,7 +1575,7 @@ @node Mathematical equations @subsubsection Mathematical equations -One can insert LaTeX inline math, surrounded by single @samp{$} signs, or +One can insert @LaTeX{} inline math, surrounded by single @samp{$} signs, or displayed math, surrounded by double @samp{$$} signs, directly inside sections. @@ -1605,8 +1609,8 @@ @node LaTeX markup @subsubsection LaTeX markup -If the published output is a LaTeX or PDF report, you can insert LaTeX markup, -that is only visible in this kind of output. +If the published output is a @LaTeX{} or PDF report, you can insert @LaTeX{} +markup, that is only visible in this kind of output. @example @group
--- a/doc/interpreter/image.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/image.txi Mon Aug 15 10:05:50 2016 -0700 @@ -71,8 +71,8 @@ It is possible to get information about an image file on disk, without actually reading it into Octave. This is done using the @code{imfinfo} function which -provides read access to many of the parameters stored in the header of the image -file. +provides read access to many of the parameters stored in the header of the +image file. @DOCSTRING(imfinfo)
--- a/doc/interpreter/nonlin.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/nonlin.txi Mon Aug 15 10:05:50 2016 -0700 @@ -174,11 +174,12 @@ to search is bounded. For unbounded minimization of a function with potentially many variables use @code{fminunc} or @code{fminsearch}. The two functions use different internal algorithms and some knowledge of the objective -function is required. For functions which can be differentiated, @code{fminunc} -is appropriate. For functions with discontinuities, or for which a gradient -search would fail, use @code{fminsearch}. @xref{Optimization}, for -minimization with the presence of constraint functions. Note that searches -can be made for maxima by simply inverting the objective function +function is required. For functions which can be differentiated, +@code{fminunc} is appropriate. For functions with discontinuities, or for +which a gradient search would fail, use @code{fminsearch}. +@xref{Optimization}, for minimization with the presence of constraint +functions. Note that searches can be made for maxima by simply inverting the +objective function @tex ($F_{max} = -F_{min}$). @end tex
--- a/doc/interpreter/numbers.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/numbers.txi Mon Aug 15 10:05:50 2016 -0700 @@ -386,18 +386,18 @@ @end example @noindent -defines the set of values @samp{[ 1, 2, 3, 4, 5 ]}, and the range +defines the set of values @code{[ 1, 2, 3, 4, 5 ]}, and the range @example 1 : 3 : 5 @end example @noindent -defines the set of values @samp{[ 1, 4 ]}. +defines the set of values @code{[ 1, 4 ]}. Although a range constant specifies a row vector, Octave does @emph{not} normally convert range constants to vectors unless it is necessary to do so. -This allows you to write a constant like @samp{1 : 10000} without using +This allows you to write a constant like @code{1 : 10000} without using 80,000 bytes of storage on a typical 32-bit workstation. A common example of when it does become necessary to convert ranges into @@ -443,16 +443,16 @@ @end example @noindent -will produce the same result as @samp{1:2:2e7-1}, but without ever forming a +will produce the same result as @code{1:2:2e7-1}, but without ever forming a vector with ten million elements. -Using zero as an increment in the colon notation, as @samp{1:0:1} is not +Using zero as an increment in the colon notation, as @code{1:0:1} is not allowed, because a division by zero would occur in determining the number of range elements. However, ranges with zero increment (i.e., all elements equal) are useful, especially in indexing, and Octave allows them to be constructed -using the built-in function @dfn{ones}. Note that because a range must be a row -vector, @samp{ones (1, 10)} produces a range, while @samp{ones (10, 1)} does -not. +using the built-in function @code{ones}. Note that because a range must be a +row vector, @code{ones (1, 10)} produces a range, while @code{ones (10, 1)} +does not. When Octave parses a range expression, it examines the elements of the expression to determine whether they are all constants. If they are, it
--- a/doc/interpreter/plot.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/plot.txi Mon Aug 15 10:05:50 2016 -0700 @@ -966,7 +966,7 @@ @qcode{"interpreter"} property of text objects. This means that when using OpenGL toolkits special symbols drawn with the @qcode{"tex"} interpreter will appear correctly on-screen but will be rendered with interpreter @qcode{"none"} -when printing unless one of the @qcode{standalone} (see below) modes is used. +when printing unless one of the @code{standalone} (see below) modes is used. These modes provide access to the pdflatex processor and therefore allow full use of @LaTeX{} commands. @@ -1411,10 +1411,11 @@ * Uitoggletool Properties:: @end menu -In this Section the graphics object properties are discussed in detail, starting -with the root figure properties and continuing through the objects -hierarchy. The documentation about a specific graphics object can be displayed -using @code{doc} function, e.g., @code{doc ("axes properties")} will show +In this Section the graphics object properties are discussed in detail, +starting with the root figure properties and continuing through the objects +hierarchy. The documentation about a specific graphics object can be +displayed using @code{doc} function, e.g., @code{doc ("axes properties")} will +show @ref{Axes Properties}. The allowed values for radio (string) properties can be retrieved @@ -2089,7 +2090,8 @@ @item edgecolor @itemx facecolor -The line and fill color of the patch objects making up the bars. @xref{Colors}. +The line and fill color of the patch objects making up the bars. +@xref{Colors}. @item xdata The nominal x positions of the bars. Changes in this property and @@ -2288,7 +2290,8 @@ @item linewidth @itemx linestyle -The line width and style of the line objects of the quiver. @xref{Line Styles}. +The line width and style of the line objects of the quiver. @xref{Line +Styles}. @item marker @itemx markerfacecolor @@ -2370,7 +2373,8 @@ @item linewidth @itemx linestyle -The line width and style of the line objects of the stairs. @xref{Line Styles}. +The line width and style of the line objects of the stairs. @xref{Line +Styles}. @item marker @itemx markeredgecolor
--- a/doc/interpreter/quad.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/quad.txi Mon Aug 15 10:05:50 2016 -0700 @@ -209,8 +209,8 @@ @end example In general there may be no way of knowing the best distribution of points ahead -of time. Or the points may come from an experiment where there is no freedom to -select the best distribution. In any case, one must remain aware of this +of time. Or the points may come from an experiment where there is no freedom +to select the best distribution. In any case, one must remain aware of this issue when using @code{trapz}. @DOCSTRING(trapz)
--- a/doc/interpreter/sparse.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/sparse.txi Mon Aug 15 10:05:50 2016 -0700 @@ -203,10 +203,10 @@ Another typical sparse matrix that is often needed is a random distribution of random elements. The functions @dfn{sprand} and @dfn{sprandn} perform -this for uniform and normal random distributions of elements. They have exactly -the same calling convention, where @code{sprand (@var{r}, @var{c}, @var{d})}, -creates an @var{r}-by-@var{c} sparse matrix with a density of filled -elements of @var{d}. +this for uniform and normal random distributions of elements. They have +exactly the same calling convention, where @code{sprand (@var{r}, @var{c}, +@var{d})}, creates an @var{r}-by-@var{c} sparse matrix with a density of +filled elements of @var{d}. Other functions of interest that directly create sparse matrices, are @dfn{diag} or its generalization @dfn{spdiags}, that can take the @@ -740,9 +740,9 @@ Octave includes a polymorphic solver for sparse matrices, where the exact solver used to factorize the matrix, depends on the properties -of the sparse matrix itself. Generally, the cost of determining the matrix type -is small relative to the cost of factorizing the matrix itself, but in any -case the matrix type is cached once it is calculated, so that it is not +of the sparse matrix itself. Generally, the cost of determining the matrix +type is small relative to the cost of factorizing the matrix itself, but in +any case the matrix type is cached once it is calculated, so that it is not re-determined each time it is used in a linear equation. The selection tree for how the linear equation is solve is
--- a/doc/interpreter/strings.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/strings.txi Mon Aug 15 10:05:50 2016 -0700 @@ -39,8 +39,8 @@ Octave can be of any length. Since the single-quote mark is also used for the transpose operator -(@pxref{Arithmetic Ops}) but double-quote marks have no other purpose in Octave, -it is best to use double-quote marks to denote strings. +(@pxref{Arithmetic Ops}) but double-quote marks have no other purpose in +Octave, it is best to use double-quote marks to denote strings. Strings can be concatenated using the notation for defining matrices. For example, the expression
--- a/doc/interpreter/tips.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/tips.txi Mon Aug 15 10:05:50 2016 -0700 @@ -65,7 +65,7 @@ When you encounter an error condition, call the function @code{error} (or @code{print_usage}). The @code{error} and @code{print_usage} functions do not return. @xref{Errors}. It is customary to prefix the error message -with the name of the function that generated it. For example, +with the name of the function that generated it. For example: @example error ("my_cool_function: input A must be a matrix");
--- a/doc/interpreter/var.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/var.txi Mon Aug 15 10:05:50 2016 -0700 @@ -53,9 +53,9 @@ There is one built-in variable with a special meaning. The @code{ans} variable always contains the result of the last computation, where the output wasn't -assigned to any variable. The code @code{a = cos (pi)} will assign the value -1 -to the variable @code{a}, but will not change the value of @code{ans}. However, -the code @code{cos (pi)} will set the value of @code{ans} to -1. +assigned to any variable. The code @code{a = cos (pi)} will assign the value +-1 to the variable @code{a}, but will not change the value of @code{ans}. +However, the code @code{cos (pi)} will set the value of @code{ans} to -1. Variables in Octave do not have fixed types, so it is possible to first store a numeric value in a variable and then to later use the same name
--- a/doc/interpreter/vectorize.txi Mon Aug 15 12:46:51 2016 +0200 +++ b/doc/interpreter/vectorize.txi Mon Aug 15 10:05:50 2016 -0700 @@ -679,8 +679,8 @@ @item Use @code{ignore_function_time_stamp} when appropriate. If you are calling lots of functions, and none of them will need to change during your run, set the variable @code{ignore_function_time_stamp} to -@qcode{"all"}. This will stop Octave from checking the time stamp of a function -file to see if it has been updated while the program is being run. +@qcode{"all"}. This will stop Octave from checking the time stamp of a +function file to see if it has been updated while the program is being run. @end itemize @node Examples
--- a/libinterp/corefcn/__dispatch__.cc Mon Aug 15 12:46:51 2016 +0200 +++ b/libinterp/corefcn/__dispatch__.cc Mon Aug 15 10:05:50 2016 -0700 @@ -41,7 +41,7 @@ DEFUN (__dispatch__, args, nargout, doc: /* -*- texinfo -*- -@deftypefn {} {} __dispatch__ () +@deftypefn {} {} __dispatch__ () Undocumented internal function. @end deftypefn */) {
--- a/libinterp/corefcn/cellfun.cc Mon Aug 15 12:46:51 2016 +0200 +++ b/libinterp/corefcn/cellfun.cc Mon Aug 15 10:05:50 2016 -0700 @@ -1016,7 +1016,7 @@ handle, an inline function, or an anonymous function. The input argument @var{A} can be a logic array, a numeric array, a string array, a structure array, or a cell array. By a call of the function -@command{arrayfun} all elements of @var{A} are passed on to the named +@code{arrayfun} all elements of @var{A} are passed on to the named function @var{func} individually. The named function can also take more than two input arguments, with
--- a/libinterp/corefcn/file-io.cc Mon Aug 15 12:46:51 2016 +0200 +++ b/libinterp/corefcn/file-io.cc Mon Aug 15 10:05:50 2016 -0700 @@ -1453,7 +1453,7 @@ @item @qcode{"ReturnOnError"} If set to numerical 1 or true, return normally as soon as an error is -encountered, such as trying to read a string using @qcode{%f}. +encountered, such as trying to read a string using @code{%f}. If set to 0 or false, return an error and no data. @item @qcode{"Whitespace"}
--- a/libinterp/corefcn/gsvd.cc Mon Aug 15 12:46:51 2016 +0200 +++ b/libinterp/corefcn/gsvd.cc Mon Aug 15 10:05:50 2016 -0700 @@ -45,11 +45,10 @@ DEFUN (gsvd, args, nargout, doc: /* -*- texinfo -*- -@deftypefn {Loadable Function} {@var{s} =} gsvd (@var{a}, @var{b}) -@deftypefnx {Loadable Function} {[@var{u}, @var{v}, @var{c}, @var{s}, @var{x} [, @var{r}]] =} gsvd (@var{a}, @var{b}) +@deftypefn {} {@var{s} =} gsvd (@var{a}, @var{b}) +@deftypefnx {} {[@var{u}, @var{v}, @var{c}, @var{s}, @var{x} [, @var{r}]] =} gsvd (@var{a}, @var{b}) @cindex generalised singular value decomposition Compute the generalised singular value decomposition of (@var{a}, @var{b}): -@iftex @tex $$ U^H A X = [I 0; 0 C] [0 R] @@ -59,63 +58,55 @@ R is upper triangular $$ @end tex -@end iftex @ifinfo @example +@group u' * a * x = [I 0; 0 c] * [0 r] v' * b * x = [0 s; 0 0] * [0 r] c * c + s * s = eye(columns(a)) I and 0 are padding matrices of suitable size r is upper triangular +@end group @end example + @end ifinfo The function @code{gsvd} normally returns the vector of generalised singular values -@iftex @tex diag(C)./diag(S). @end tex -@end iftex @ifinfo diag(r)./diag(s). @end ifinfo If asked for five return values, it computes -@iftex @tex $U$, $V$, and $X$. @end tex -@end iftex @ifinfo U, V, and X. @end ifinfo With a sixth output argument, it also returns -@iftex @tex R, @end tex -@end iftex @ifinfo r, @end ifinfo -The common upper triangular right term. Other authors, like S. Van Huffel, +The common upper triangular right term. Other authors, like S. Van Huffel, define this transformation as the simulatenous diagonalisation of the input matrices, this can be achieved by multiplying -@iftex @tex X @end tex -@end iftex @ifinfo x @end ifinfo by the inverse of -@iftex @tex [I 0; 0 R]. @end tex -@end iftex @ifinfo [I 0; 0 r]. @end ifinfo @@ -130,10 +121,12 @@ returns @example +@group ans = 0.1055705 0.0031759 +@end group @end example @noindent @@ -179,7 +172,8 @@ @end example -The code is a wrapper to the corresponding Lapack dggsvd and zggsvd routines. +The code is a wrapper to the corresponding @sc{lapack} dggsvd and zggsvd +routines. @end deftypefn */) {
--- a/libinterp/corefcn/load-path.cc Mon Aug 15 12:46:51 2016 +0200 +++ b/libinterp/corefcn/load-path.cc Mon Aug 15 10:05:50 2016 -0700 @@ -2547,7 +2547,7 @@ DEFUN (__dump_load_path__, , , doc: /* -*- texinfo -*- -@deftypefn {} {} __dump_load_path__ () +@deftypefn {} {} __dump_load_path__ () Undocumented internal function. @end deftypefn */) {
--- a/libinterp/corefcn/regexp.cc Mon Aug 15 12:46:51 2016 +0200 +++ b/libinterp/corefcn/regexp.cc Mon Aug 15 10:05:50 2016 -0700 @@ -682,9 +682,10 @@ @item [@dots{}] [^@dots{}] -List operators. The pattern will match any character listed between "[" -and "]". If the first character is "^" then the pattern is inverted and -any character except those listed between brackets will match. +List operators. The pattern will match any character listed between +@qcode{"["} and @qcode{"]"}. If the first character is @qcode{"^"} then the +pattern is inverted and any character except those listed between brackets +will match. Escape sequences defined below can also be used inside list operators. For example, a template for a floating point number might be @code{[-+.\d]+}. @@ -1345,7 +1346,7 @@ @end example @noindent -returns "Dunn, Bill" +returns @qcode{"Dunn, Bill"} Options in addition to those of @code{regexp} are
--- a/libinterp/dldfcn/__init_gnuplot__.cc Mon Aug 15 12:46:51 2016 +0200 +++ b/libinterp/dldfcn/__init_gnuplot__.cc Mon Aug 15 10:05:50 2016 -0700 @@ -209,7 +209,7 @@ DEFUN_DLD (__init_gnuplot__, , , doc: /* -*- texinfo -*- -@deftypefn {} {} __init_gnuplot__ () +@deftypefn {} {} __init_gnuplot__ () Undocumented internal function. @end deftypefn */) {
--- a/libinterp/dldfcn/__osmesa_print__.cc Mon Aug 15 12:46:51 2016 +0200 +++ b/libinterp/dldfcn/__osmesa_print__.cc Mon Aug 15 10:05:50 2016 -0700 @@ -63,7 +63,7 @@ The first method calls gl2ps with the appropriate @var{term} and writes the output of gl2ps to @var{file}. If the first character of @var{file} -is @qcode{|}, then a process is started and the output of gl2ps is piped +is @code{|}, then a process is started and the output of gl2ps is piped to it. Valid options for @var{term}, which can be concatenated in one string, are: @@ -72,11 +72,11 @@ @item @qcode{eps}, @qcode{pdf}, @qcode{ps}, @qcode{svg}, @qcode{pgf}, @qcode{tex} Select output format. -@item @qcode{is2D} +@item @code{is2D} Use GL2PS_SIMPLE_SORT instead of GL2PS_BSP_SORT as Z-depth sorting algorithm. -@item @qcode{notext} +@item @code{notext} Don't render text. @end table
--- a/libinterp/dldfcn/qr.cc Mon Aug 15 12:46:51 2016 +0200 +++ b/libinterp/dldfcn/qr.cc Mon Aug 15 10:05:50 2016 -0700 @@ -78,7 +78,7 @@ @deftypefn {} {[@var{Q}, @var{R}] =} qr (@var{A}) @deftypefnx {} {[@var{Q}, @var{R}, @var{P}] =} qr (@var{A}) # non-sparse A @deftypefnx {} {@var{X} =} qr (@var{A}) -@deftypefnx {} {@var{R} =} qr (@var{A}) # sparse A +@deftypefnx {} {@var{R} =} qr (@var{A}) # sparse A @deftypefnx {} {[@var{C}, @var{R}] =} qr (@var{A}, @var{B}) @deftypefnx {} {[@dots{}] =} qr (@dots{}, 0) @deftypefnx {} {[@dots{}] =} qr (@dots{}, 'vector') @@ -205,13 +205,13 @@ @end example If the final argument is the scalar 0 and the number of rows is larger -than the number of columns, then an 'economy' factorization is returned, -omitting zeroes of @var{R} and the corresponding columns of @var{Q}. -That is, @var{R} will have only @code{size (@var{A},1)} rows. -In this case, @var{P} is a vector rather than a matrix. +than the number of columns, then an @qcode{"economy"} factorization is +returned, omitting zeroes of @var{R} and the corresponding columns of @var{Q}. +That is, @var{R} will have only @code{size (@var{A},1)} rows. In this case, +@var{P} is a vector rather than a matrix. -If the final argument is the string 'vector' then @var{P} is a permutation -vector instead of a permutation matrix. +If the final argument is the string @qcode{"vector"} then @var{P} is a +permutation vector instead of a permutation matrix. @seealso{chol, hess, lu, qz, schur, svd, qrupdate, qrinsert, qrdelete, qrshift} @end deftypefn */)
--- a/libinterp/dldfcn/xzip.cc Mon Aug 15 12:46:51 2016 +0200 +++ b/libinterp/dldfcn/xzip.cc Mon Aug 15 10:05:50 2016 -0700 @@ -22,7 +22,7 @@ - created file is always in the same directory as the original file; - automatically skip files that already have gz/bz2/etc extension; - - some olders versions miss the --keep option. + - some older versions lack the --keep option. In addition, because system() does not have a method that allows passing a list of arguments, there is the issue of having to escape
--- a/libinterp/octave-value/ov-classdef.cc Mon Aug 15 12:46:51 2016 +0200 +++ b/libinterp/octave-value/ov-classdef.cc Mon Aug 15 10:05:50 2016 -0700 @@ -3720,7 +3720,7 @@ DEFUN (__meta_get_package__, args, , doc: /* -*- texinfo -*- -@deftypefn {} {} __meta_get_package__ () +@deftypefn {} {} __meta_get_package__ () Undocumented internal function. @end deftypefn */) {
--- a/scripts/deprecated/octave_config_info.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/deprecated/octave_config_info.m Mon Aug 15 10:05:50 2016 -0700 @@ -17,8 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Built-in Function} {} octave_config_info () -## @deftypefnx {Built-in Function} {} octave_config_info (@var{option}) +## @deftypefn {} {} octave_config_info () +## @deftypefnx {} {} octave_config_info (@var{option}) ## ## @code{octave_config_info} is deprecated and will be removed in ## Octave version 4.6. Use @code{__have_feature__ (@var{option})} or
--- a/scripts/general/grabcode.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/general/grabcode.m Mon Aug 15 10:05:50 2016 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {} grabcode (@var{url}) +## @deftypefn {} {} grabcode (@var{url}) ## @deftypefnx {} {@var{code_str} =} grabcode (@var{url}) ## ## Grab by the @code{publish} function generated HTML reports from Octave
--- a/scripts/general/publish.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/general/publish.m Mon Aug 15 10:05:50 2016 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {} publish (@var{filename}) +## @deftypefn {} {} publish (@var{filename}) ## @deftypefnx {} {} publish (@var{filename}, @var{output_format}) ## @deftypefnx {} {} publish (@var{filename}, @var{option1}, @var{value1}, @dots{}) ## @deftypefnx {} {} publish (@var{filename}, @var{options}) @@ -71,6 +71,7 @@ ## @end group ## @end example ## +## @noindent ## which is described below. The same holds for using option-value-pairs ## ## @example @@ -91,7 +92,7 @@ ## @samp{xml}, or @samp{pdf}. ## ## The output formats @samp{doc}, @samp{ppt}, and @samp{xml} are currently -## not supported. To generate a @samp{doc} report, open a generated +## not supported. To generate a @samp{doc} report, open a generated ## @samp{html} report with your office suite. ## ## @item @@ -100,13 +101,13 @@ ## in a subdirectory @samp{html} relative to the current working directory. ## ## @item -## @samp{stylesheet} --- Not supported, only for Matlab compatibility. +## @samp{stylesheet} --- Not supported, only for @sc{matlab} compatibility. ## ## @item -## @samp{createThumbnail} --- Not supported, only for Matlab compatibility. +## @samp{createThumbnail} --- Not supported, only for @sc{matlab} compatibility. ## ## @item -## @samp{figureSnapMethod} --- Not supported, only for Matlab compatibility. +## @samp{figureSnapMethod} --- Not supported, only for @sc{matlab} compatibility. ## ## @item ## @samp{imageFormat} --- Desired format for images produced, while @@ -120,7 +121,7 @@ ## @item @samp{latex} --- @samp{epsc2} (default), any other image format ## supported by Octave ## -## @item @samp{pdf} --- @samp{jpg} (default) or @samp{bmp}, note Matlab +## @item @samp{pdf} --- @samp{jpg} (default) or @samp{bmp}, note @sc{matlab} ## uses @samp{bmp} as default ## ## @item @samp{doc} or @samp{ppt} --- @samp{png} (default), @samp{jpg},
--- a/scripts/gui/dialog.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/gui/dialog.m Mon Aug 15 10:05:50 2016 -0700 @@ -17,11 +17,12 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {@var{h} = } dialog (@dots{}, "@var{property}", @var{value}, @dots{}) +## @deftypefn {} {@var{h} =} dialog (@dots{}, "@var{property}", @var{value}, @dots{}) ## ## Create an empty modal dialog window that other uicontrols can be added to. ## -## The dialog box is a figure object with properties as recommended for a dialog box. +## The dialog box is a figure object with properties as recommended for a +## dialog box. ## ## The default properties differing from a figure are: ##
--- a/scripts/linear-algebra/condest.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/linear-algebra/condest.m Mon Aug 15 10:05:50 2016 -0700 @@ -35,24 +35,33 @@ ## ## @itemize @minus ## @item @var{afun} which should returns +## ## @itemize @bullet ## @item -## the dimension @var{n} of @var{a}, if @var{flag} is "dim" +## the dimension @var{n} of @var{a}, if @var{flag} is @qcode{"dim"} +## ## @item -## true if @var{a} is a real operator, if @var{flag} is "real" +## true if @var{a} is a real operator, if @var{flag} is @qcode{"real"} +## ## @item ## the result @code{@var{a} * @var{x}}, if @var{flag} is "notransp" +## ## @item ## the result @code{@var{a}' * @var{x}}, if @var{flag} is "transp" ## @end itemize +## ## @item @var{solvefun} which should returns +## ## @itemize @bullet ## @item -## the dimension @var{n} of @var{a}, if @var{flag} is "dim" +## the dimension @var{n} of @var{a}, if @var{flag} is @qcode{"dim"} +## ## @item -## true if @var{a} is a real operator, if @var{flag} is "real" +## true if @var{a} is a real operator, if @var{flag} is @qcode{"real"} +## ## @item ## the result @code{@var{a} \ @var{x}}, if @var{flag} is "notransp" +## ## @item ## the result @code{@var{a}' \ @var{x}}, if @var{flag} is "transp" ## @end itemize @@ -64,8 +73,9 @@ ## @dots{})}. ## ## @code{condest} uses a randomized algorithm to approximate the -## 1-norms. Therefore, if consistent results are required, the "state" of the -## random generator should be fixed before invoking @code{normest1}. +## 1-norms. Therefore, if consistent results are required, the +## @qcode{"state"} of the random generator should be fixed before invoking +## @code{normest1}. ## ## @code{condest} returns the 1-norm condition estimate @var{est} and a vector ## @var{v} satisfying @code{norm (A*v, 1) == norm (A, 1) * norm
--- a/scripts/linear-algebra/normest1.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/linear-algebra/normest1.m Mon Aug 15 10:05:50 2016 -0700 @@ -17,31 +17,34 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{c} =} normest1 (@var{a}) -## @deftypefnx {Function File} {@var{c} =} normest1 (@var{a}, @var{t}) -## @deftypefnx {Function File} {@var{c} =} normest1 (@var{a}, @var{t}, @var{x0}) -## @deftypefnx {Function File} {@var{c} =} normest1 (@var{afun}, @var{t}, @var{x0}, @var{p1}, @var{p2}, @dots{}) -## @deftypefnx {Function File} {[@var{c}, @var{v}] =} normest1 (@var{a}, @dots{}) -## @deftypefnx {Function File} {[@var{c}, @var{v}, @var{w}] =} normest1 (@var{a}, @dots{}) -## @deftypefnx {Function File} {[@var{c}, @var{v}, @var{w}, @var{it}] =} normest1 (@var{a}, @dots{}) +## @deftypefn {} {@var{c} =} normest1 (@var{a}) +## @deftypefnx {} {@var{c} =} normest1 (@var{a}, @var{t}) +## @deftypefnx {} {@var{c} =} normest1 (@var{a}, @var{t}, @var{x0}) +## @deftypefnx {} {@var{c} =} normest1 (@var{afun}, @var{t}, @var{x0}, @var{p1}, @var{p2}, @dots{}) +## @deftypefnx {} {[@var{c}, @var{v}] =} normest1 (@var{a}, @dots{}) +## @deftypefnx {} {[@var{c}, @var{v}, @var{w}] =} normest1 (@var{a}, @dots{}) +## @deftypefnx {} {[@var{c}, @var{v}, @var{w}, @var{it}] =} normest1 (@var{a}, @dots{}) ## Estimate the 1-norm of the matrix @var{a} using a block algorithm. ## ## For a medium size matrix @var{a}, @code{norm (@var{a}, 1)} should be -## used instead. For a large sparse matrix, when only an estimate of the norm -## is needed, @code{normest1 (@var{a})} might be faster. Moreover, it can be +## used instead. For a large sparse matrix, when only an estimate of the norm +## is needed, @code{normest1 (@var{a})} might be faster. Moreover, it can be ## used for the estimate of the 1-norm of a linear ## operator @var{a} when matrix-vector products @code{@var{a} * @var{x}} and -## @code{@var{a}' * @var{x}} can be cheaply computed. In this case, +## @code{@var{a}' * @var{x}} can be cheaply computed. In this case, ## instead of the matrix @var{a}, a function -## @code{@var{afun} (@var{flag}, @var{x})} can be used. It should return: +## @code{@var{afun} (@var{flag}, @var{x})} can be used. It should return: ## ## @itemize @bullet ## @item ## the dimension @var{n} of @var{a}, if @var{flag} is @qcode{"dim"} +## ## @item ## true if @var{a} is a real operator, if @var{flag} is @qcode{"real"} +## ## @item ## the result @code{@var{a} * @var{x}}, if @var{flag} is @qcode{"notransp"} +## ## @item ## the result @code{@var{a}' * @var{x}}, if @var{flag} is @qcode{"transp"} ## @end itemize @@ -51,10 +54,12 @@ ## even forming explicitely @code{@var{b} ^ @var{m}} by: ## ## @example +## @group ## @var{y} = @var{x}; ## for @var{i} = 1:@var{m} ## @var{y} = @var{b} * @var{y}; ## endfor +## @end group ## @end example ## ## The parameters @var{p1}, @var{p2}, @dots{} are arguments of @@ -69,7 +74,7 @@ ## @code{ones (@var{n}, 1) / @var{n}} ## and, if @var{t} > 1, the remaining columns with random elements ## @code{-1 / @var{n}}, @code{1 / @var{n}}, divided by @var{n}. -## Therefore, if consistent results are required, the "state" of the +## Therefore, if consistent results are required, the @qcode{"state"} of the ## random generator should be fixed before invoking @code{normest1}. ## ## On output, @var{c} is the desired estimate, @var{v} and @var{w}
--- a/scripts/miscellaneous/mkdir.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/miscellaneous/mkdir.m Mon Aug 15 10:05:50 2016 -0700 @@ -17,7 +17,7 @@ ## -*- texinfo -*- ## @deftypefn {} {} mkdir @var{dir} ## @deftypefnx {} {} mkdir (@var{parent}, @var{dir}) -## @deftypefnx {} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (...) +## @deftypefnx {} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@dots{}) ## Create a directory named @var{dir} in the directory @var{parent}, ## creating any intermediate directories if necessary. ##
--- a/scripts/ode/ode23.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/ode/ode23.m Mon Aug 15 10:05:50 2016 -0700 @@ -40,7 +40,7 @@ ## final times (@code{[tinit, tfinal]}). If there are more than two elements ## then the solution will also be evaluated at these intermediate time ## instances unless the integrate function specified is -## @command{integrate_n_steps}. +## @code{integrate_n_steps}. ## ## By default, @code{ode23} uses an adaptive timestep with the ## @code{integrate_adaptive} algorithm. The tolerance for the timestep
--- a/scripts/ode/ode45.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/ode/ode45.m Mon Aug 15 10:05:50 2016 -0700 @@ -38,7 +38,7 @@ ## final times (@code{[tinit, tfinal]}). If there are more than two elements ## then the solution will also be evaluated at these intermediate time ## instances unless the integrate function specified is -## @command{integrate_n_steps}. +## @code{integrate_n_steps}. ## ## By default, @code{ode45} uses an adaptive timestep with the ## @code{integrate_adaptive} algorithm. The tolerance for the timestep
--- a/scripts/ode/odeplot.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/ode/odeplot.m Mon Aug 15 10:05:50 2016 -0700 @@ -41,7 +41,7 @@ ## @end table ## ## This function is called by an ode solver function if it was specified in -## an options structure with the @command{odeset}. This function is an +## an options structure with the @code{odeset}. This function is an ## internal helper function therefore it should never be necessary that this ## function is called directly by a user. There is only little error ## detection implemented in this function file to achieve the highest
--- a/scripts/ode/private/AbsRel_Norm.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/ode/private/AbsRel_Norm.m Mon Aug 15 10:05:50 2016 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {retval =} AbsRel_Norm (@var{x}, @var{x_old}, @var{AbsTol}, @var{RelTol}, @var{normcoontrol}, @var{y}) +## @deftypefn {} {retval =} AbsRel_Norm (@var{x}, @var{x_old}, @var{AbsTol}, @var{RelTol}, @var{normcoontrol}, @var{y}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/ode/private/integrate_adaptive.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/ode/private/integrate_adaptive.m Mon Aug 15 10:05:50 2016 -0700 @@ -42,9 +42,11 @@ ## defines the ODE: ## ## @ifhtml +## ## @example ## @math{y' = f(t,y)} ## @end example +## ## @end ifhtml ## @ifnothtml ## @math{y' = f(t,y)}.
--- a/scripts/ode/private/integrate_const.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/ode/private/integrate_const.m Mon Aug 15 10:05:50 2016 -0700 @@ -41,9 +41,11 @@ ## defines the ODE: ## ## @ifhtml +## ## @example ## @math{y' = f(t,y)} ## @end example +## ## @end ifhtml ## @ifnothtml ## @math{y' = f(t,y)}.
--- a/scripts/ode/private/integrate_n_steps.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/ode/private/integrate_n_steps.m Mon Aug 15 10:05:50 2016 -0700 @@ -41,9 +41,11 @@ ## defines the ODE: ## ## @ifhtml +## ## @example ## @math{y' = f(t,y)} ## @end example +## ## @end ifhtml ## @ifnothtml ## @math{y' = f(t,y)}.
--- a/scripts/plot/appearance/axis.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/plot/appearance/axis.m Mon Aug 15 10:05:50 2016 -0700 @@ -56,7 +56,8 @@ ## @end example ## ## @noindent -## turns tick marks on for all axes and tick mark labels on for the y-axis only. +## turns tick marks on for all axes and tick mark labels on for the y-axis +## only. ## ## @noindent ## The following options control the aspect ratio of the axes.
--- a/scripts/plot/draw/isocaps.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/plot/draw/isocaps.m Mon Aug 15 10:05:50 2016 -0700 @@ -35,8 +35,8 @@ ## sampled over a volume. ## ## The input @var{isoval} is a scalar that specifies the value for the -## isosurface. If @var{isoval} is omitted or empty, a "good" value for an -## isosurface is determined from @var{v}. +## isosurface. If @var{isoval} is omitted or empty, a @nospell{"good"} value +## for an isosurface is determined from @var{v}. ## ## When called with a single output argument, @code{isocaps} returns a ## structure array @var{fvc} with the fields: @code{faces}, @code{vertices},
--- a/scripts/plot/draw/isocolors.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/plot/draw/isocolors.m Mon Aug 15 10:05:50 2016 -0700 @@ -31,7 +31,7 @@ ## the second input argument @var{v} keeps the vertices of a geometry ## then return a matrix @var{cd} with color data information for the ## geometry at computed points -## @command{[x, y, z] = meshgrid (1:l, 1:m, 1:n)}. The output argument +## @code{[x, y, z] = meshgrid (1:l, 1:m, 1:n)}. The output argument ## @var{cd} can be taken to manually set FaceVertexCData of a patch. ## ## If called with further input arguments @var{x}, @var{y} and @var{z} @@ -39,7 +39,7 @@ ## then the color data is taken at those given points. Instead of the ## color data @var{c} this function can also be called with RGB values ## @var{r}, @var{g}, @var{b}. If input argumnets @var{x}, @var{y}, -## @var{z} are not given then again @command{meshgrid} computed values +## @var{z} are not given then again @code{meshgrid} computed values ## are taken. ## ## Optionally, the patch handle @var{p} can be given as the last input
--- a/scripts/plot/draw/isosurface.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/plot/draw/isosurface.m Mon Aug 15 10:05:50 2016 -0700 @@ -37,7 +37,7 @@ ## sampled over a volume. ## ## The input @var{isoval} is a scalar that specifies the value for the -## isosurface. If @var{isoval} is omitted or empty, a @qcode{"good"} value +## isosurface. If @var{isoval} is omitted or empty, a @nospell{"good"} value ## for an isosurface is determined from @var{v}. ## ## When called with a single output argument @code{isosurface} returns a
--- a/scripts/plot/draw/light.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/plot/draw/light.m Mon Aug 15 10:05:50 2016 -0700 @@ -24,13 +24,13 @@ ## Create light object in the current axes or for axes @var{hax}. ## ## When a light object is present in an axes object and the properties -## @qcode{"EdgeLighting"} or @qcode{"FaceLighting"} of a @command{patch} or -## @command{surface} object are set to a value other than @qcode{"none"}, these +## @qcode{"EdgeLighting"} or @qcode{"FaceLighting"} of a @code{patch} or +## @code{surface} object are set to a value other than @qcode{"none"}, these ## objects are drawn with light and shadow effects. Supported values for these ## properties are @qcode{"none"} (no lighting effects), @qcode{"flat"} ## (facetted look of the objects) and @qcode{"gouraud"} (linear interpolation ## of the lighting effects between the vertices). -## For @command{patch} objects, the normals must be set manually (property +## For @code{patch} objects, the normals must be set manually (property ## @qcode{"VertexNormals"}). ## ## Up to eight light objects are supported per axes. @@ -43,18 +43,18 @@ ## ## @table @asis ## @item @qcode{"Color":} The color of the light object can be passed as an -## RGB-vector (e.g. @qcode{[1 0 0]} for red) or as a string (e.g. @qcode{"r"} -## for red). The default color is white (@qcode{[1 1 1]}). +## RGB-vector (e.g., @code{[1 0 0]} for red) or as a string (e.g., @qcode{"r"} +## for red). The default color is white (@code{[1 1 1]}). ## ## @item @qcode{"Position":} The direction from which the light emanates as an -## 1x3-vector. The default direction is @qcode{[1 0 1]}. +## 1x3-vector. The default direction is @code{[1 0 1]}. ## ## @item @qcode{"Style":} This string defines whether the light emanates from a ## light source at infinite distance (@qcode{"infinite"}) or from a local point ## source (@qcode{"local"}). ## @end table ## -## If @command{light} is called with an axes handle @var{hax}, it must be passed +## If @code{light} is called with an axes handle @var{hax}, it must be passed ## as the first argument. ## ## Optionally, the handle to the light object is returned in @var{h}.
--- a/scripts/plot/draw/private/__calc_isovalue_from_data__.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/plot/draw/private/__calc_isovalue_from_data__.m Mon Aug 15 10:05:50 2016 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {} {@var{isoval} =} __calc_isovalue_from_data__ (@var{data}) -## Calculate a "good" iso value from histogram of data. +## Calculate a @nospell{"good"} iso value from histogram of data. ## @end deftypefn ## called from isocaps, isosurface
--- a/scripts/plot/draw/private/__marching_cube__.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/plot/draw/private/__marching_cube__.m Mon Aug 15 10:05:50 2016 -0700 @@ -60,7 +60,7 @@ ## @end group ## @end example ## -## Instead of the @command{trimesh} function the @command{patch} +## Instead of the @code{trimesh} function the @code{patch} ## function can be used to visualize the geometry. For example: ## ## @example
--- a/scripts/statistics/base/cov.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/statistics/base/cov.m Mon Aug 15 10:05:50 2016 -0700 @@ -62,8 +62,8 @@ ## univariate distributions regardless of their shapes, and will calculate ## @code{cov ([@var{x}(:), @var{y}(:)])} whenever the number of elements in ## @var{x} and @var{y} are equal. This will result in a 2x2 matrix. -## Code relying on @sc{Matlab}'s definition will need to be -## changed when running in Octave. +## Code relying on @sc{matlab}'s definition will need to be changed when +## running in Octave. ## @seealso{corr} ## @end deftypefn
--- a/scripts/statistics/base/median.m Mon Aug 15 12:46:51 2016 +0200 +++ b/scripts/statistics/base/median.m Mon Aug 15 10:05:50 2016 -0700 @@ -42,7 +42,7 @@ ## ## @end ifnottex ## If @var{x} is of a discrete type such as integer or logical, then -## the case of even N rounds up (or toward @qcode{true}). +## the case of even N rounds up (or toward @code{true}). ## ## If @var{x} is a matrix, compute the median value for each column and ## return them in a row vector.