changeset 24618:c99163d188df stable

doc: Use @var{} around variables in operator functions such as and, or, uplus. * data.cc (Fnot, Fuplus, Fuminus, Ftranspose, Fctranspose, Fplus, Fminus, Fmtimes, Fmrdivide, Fmpower, Fmldivide, Flt, Fle, Feq, Fge, Fgt, Fne, Ftimes, Frdivide, Fpower, Fldivide, Fand, For, Fcolon): Use @var{} around variables in docstrings.
author Rik <rik@octave.org>
date Wed, 17 Jan 2018 17:49:41 -0800
parents 60d6914d801b
children c241918d4c92 10e8dc9d453c
files libinterp/corefcn/data.cc
diffstat 1 files changed, 36 insertions(+), 34 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/data.cc	Tue Jan 16 11:46:27 2018 -0800
+++ b/libinterp/corefcn/data.cc	Wed Jan 17 17:49:41 2018 -0800
@@ -5846,7 +5846,7 @@
 @deftypefn {} {@var{z} =} not (@var{x})
 Return the logical NOT of @var{x}.
 
-This function is equivalent to the operator syntax @w{@code{! x}}.
+This function is equivalent to the operator syntax @w{@code{! @var{x}}}.
 @seealso{and, or, xor}
 @end deftypefn */)
 {
@@ -5856,7 +5856,7 @@
 DEFUN (uplus, args, ,
        doc: /* -*- texinfo -*-
 @deftypefn {} {} uplus (@var{x})
-This function and @w{@tcode{+ x}} are equivalent.
+This function and @w{@tcode{+ @var{x}}} are equivalent.
 @seealso{uminus, plus, minus}
 @end deftypefn */)
 {
@@ -5866,7 +5866,7 @@
 DEFUN (uminus, args, ,
        doc: /* -*- texinfo -*-
 @deftypefn {} {} uminus (@var{x})
-This function and @w{@tcode{- x}} are equivalent.
+This function and @w{@tcode{- @var{x}}} are equivalent.
 @seealso{uplus, minus}
 @end deftypefn */)
 {
@@ -5878,7 +5878,7 @@
 @deftypefn {} {} transpose (@var{x})
 Return the transpose of @var{x}.
 
-This function and @tcode{x.'} are equivalent.
+This function and @tcode{@var{x}.'} are equivalent.
 @seealso{ctranspose}
 @end deftypefn */)
 {
@@ -5910,7 +5910,7 @@
 @deftypefn {} {} ctranspose (@var{x})
 Return the complex conjugate transpose of @var{x}.
 
-This function and @tcode{x'} are equivalent.
+This function and @tcode{@var{x}'} are equivalent.
 @seealso{transpose}
 @end deftypefn */)
 {
@@ -5978,13 +5978,13 @@
        doc: /* -*- texinfo -*-
 @deftypefn  {} {} plus (@var{x}, @var{y})
 @deftypefnx {} {} plus (@var{x1}, @var{x2}, @dots{})
-This function and @w{@tcode{x + y}} are equivalent.
+This function and @w{@tcode{@var{x} + @var{y}}} are equivalent.
 
 If more arguments are given, the summation is applied
 cumulatively from left to right:
 
 @example
-(@dots{}((x1 + x2) + x3) + @dots{})
+(@dots{}((@var{x1} + @var{x2}) + @var{x3}) + @dots{})
 @end example
 
 At least one argument is required.
@@ -5998,7 +5998,7 @@
 DEFUN (minus, args, ,
        doc: /* -*- texinfo -*-
 @deftypefn {} {} minus (@var{x}, @var{y})
-This function and @w{@tcode{x - y}} are equivalent.
+This function and @w{@tcode{@var{x} - @var{y}}} are equivalent.
 @seealso{plus, uminus}
 @end deftypefn */)
 {
@@ -6011,12 +6011,12 @@
 @deftypefnx {} {} mtimes (@var{x1}, @var{x2}, @dots{})
 Return the matrix multiplication product of inputs.
 
-This function and @w{@tcode{x * y}} are equivalent.
+This function and @w{@tcode{@var{x} * @var{y}}} are equivalent.
 If more arguments are given, the multiplication is applied
 cumulatively from left to right:
 
 @example
-(@dots{}((x1 * x2) * x3) * @dots{})
+(@dots{}((@var{x1} * @var{x2}) * @var{x3}) * @dots{})
 @end example
 
 At least one argument is required.
@@ -6032,7 +6032,7 @@
 @deftypefn {} {} mrdivide (@var{x}, @var{y})
 Return the matrix right division of @var{x} and @var{y}.
 
-This function and @w{@tcode{x / y}} are equivalent.
+This function and @w{@tcode{@var{x} / @var{y}}} are equivalent.
 @seealso{mldivide, rdivide, plus, minus}
 @end deftypefn */)
 {
@@ -6044,7 +6044,7 @@
 @deftypefn {} {} mpower (@var{x}, @var{y})
 Return the matrix power operation of @var{x} raised to the @var{y} power.
 
-This function and @w{@tcode{x ^ y}} are equivalent.
+This function and @w{@tcode{@var{x} ^ @var{y}}} are equivalent.
 @seealso{power, mtimes, plus, minus}
 @end deftypefn */)
 {
@@ -6056,7 +6056,7 @@
 @deftypefn {} {} mldivide (@var{x}, @var{y})
 Return the matrix left division of @var{x} and @var{y}.
 
-This function and @w{@tcode{x @xbackslashchar{} y}} are equivalent.
+This function and @w{@tcode{@var{x} @xbackslashchar{} @var{y}}} are equivalent.
 @seealso{mrdivide, ldivide, rdivide}
 @end deftypefn */)
 {
@@ -6066,7 +6066,7 @@
 DEFUN (lt, args, ,
        doc: /* -*- texinfo -*-
 @deftypefn {} {} lt (@var{x}, @var{y})
-This function is equivalent to @w{@code{x < y}}.
+This function is equivalent to @w{@code{@var{x} < @var{y}}}.
 @seealso{le, eq, ge, gt, ne}
 @end deftypefn */)
 {
@@ -6076,7 +6076,7 @@
 DEFUN (le, args, ,
        doc: /* -*- texinfo -*-
 @deftypefn {} {} le (@var{x}, @var{y})
-This function is equivalent to @w{@code{x <= y}}.
+This function is equivalent to @w{@code{@var{x} <= @var{y}}}.
 @seealso{eq, ge, gt, ne, lt}
 @end deftypefn */)
 {
@@ -6088,7 +6088,7 @@
 @deftypefn {} {} eq (@var{x}, @var{y})
 Return true if the two inputs are equal.
 
-This function is equivalent to @w{@code{x == y}}.
+This function is equivalent to @w{@code{@var{x} == @var{y}}}.
 @seealso{ne, isequal, le, ge, gt, ne, lt}
 @end deftypefn */)
 {
@@ -6098,7 +6098,7 @@
 DEFUN (ge, args, ,
        doc: /* -*- texinfo -*-
 @deftypefn {} {} ge (@var{x}, @var{y})
-This function is equivalent to @w{@code{x >= y}}.
+This function is equivalent to @w{@code{@var{x} >= @var{y}}}.
 @seealso{le, eq, gt, ne, lt}
 @end deftypefn */)
 {
@@ -6108,7 +6108,7 @@
 DEFUN (gt, args, ,
        doc: /* -*- texinfo -*-
 @deftypefn {} {} gt (@var{x}, @var{y})
-This function is equivalent to @w{@code{x > y}}.
+This function is equivalent to @w{@code{@var{x} > @var{y}}}.
 @seealso{le, eq, ge, ne, lt}
 @end deftypefn */)
 {
@@ -6120,7 +6120,7 @@
 @deftypefn {} {} ne (@var{x}, @var{y})
 Return true if the two inputs are not equal.
 
-This function is equivalent to @w{@code{x != y}}.
+This function is equivalent to @w{@code{@var{x} != @var{y}}}.
 @seealso{eq, isequal, le, ge, lt}
 @end deftypefn */)
 {
@@ -6133,12 +6133,12 @@
 @deftypefnx {} {} times (@var{x1}, @var{x2}, @dots{})
 Return the element-by-element multiplication product of inputs.
 
-This function and @w{@tcode{x .* y}} are equivalent.
+This function and @w{@tcode{@var{x} .* @var{y}}} are equivalent.
 If more arguments are given, the multiplication is applied
 cumulatively from left to right:
 
 @example
-(@dots{}((x1 .* x2) .* x3) .* @dots{})
+(@dots{}((@var{x1} .* @var{x2}) .* @var{x3}) .* @dots{})
 @end example
 
 At least one argument is required.
@@ -6154,7 +6154,7 @@
 @deftypefn {} {} rdivide (@var{x}, @var{y})
 Return the element-by-element right division of @var{x} and @var{y}.
 
-This function and @w{@tcode{x ./ y}} are equivalent.
+This function and @w{@tcode{@var{x} ./ @var{y}}} are equivalent.
 @seealso{ldivide, mrdivide, times, plus}
 @end deftypefn */)
 {
@@ -6167,7 +6167,7 @@
 Return the element-by-element operation of @var{x} raised to the
 @var{y} power.
 
-This function and @w{@tcode{x .^ y}} are equivalent.
+This function and @w{@tcode{@var{x} .^ @var{y}}} are equivalent.
 
 If several complex results are possible, returns the one with smallest
 non-negative argument (angle).  Use @code{realpow}, @code{realsqrt},
@@ -6184,7 +6184,8 @@
 @deftypefn {} {} ldivide (@var{x}, @var{y})
 Return the element-by-element left division of @var{x} and @var{y}.
 
-This function and @w{@tcode{x .@xbackslashchar{} y}} are equivalent.
+This function and @w{@tcode{@var{x} .@xbackslashchar{} @var{y}}} are
+equivalent.
 @seealso{rdivide, mldivide, times, plus}
 @end deftypefn */)
 {
@@ -6197,12 +6198,12 @@
 @deftypefnx {} {@var{z} =} and (@var{x1}, @var{x2}, @dots{})
 Return the logical AND of @var{x} and @var{y}.
 
-This function is equivalent to the operator syntax @w{@code{x & y}}.  If
-more than two arguments are given, the logical AND is applied cumulatively
-from left to right:
+This function is equivalent to the operator syntax
+@w{@code{@var{x} & @var{y}}}.  If more than two arguments are given, the
+logical AND is applied cumulatively from left to right:
 
 @example
-(@dots{}((x1 & x2) & x3) & @dots{})
+(@dots{}((@var{x1} & @var{x2}) & @var{x3}) & @dots{})
 @end example
 
 At least one argument is required.
@@ -6219,12 +6220,12 @@
 @deftypefnx {} {@var{z} =} or (@var{x1}, @var{x2}, @dots{})
 Return the logical OR of @var{x} and @var{y}.
 
-This function is equivalent to the operator syntax @w{@code{x | y}}.  If
-more than two arguments are given, the logical OR is applied cumulatively
-from left to right:
+This function is equivalent to the operator syntax
+@w{@code{@var{x} | @var{y}}}.  If more than two arguments are given, the
+logical OR is applied cumulatively from left to right:
 
 @example
-(@dots{}((x1 | x2) | x3) | @dots{})
+(@dots{}((@var{x1} | @var{x2}) | @var{x3}) | @dots{})
 @end example
 
 At least one argument is required.
@@ -6242,8 +6243,9 @@
 Return the result of the colon expression corresponding to @var{base},
 @var{limit}, and optionally, @var{increment}.
 
-This function is equivalent to the operator syntax @w{@code{base : limit}}
-or @w{@code{base : increment : limit}}.
+This function is equivalent to the operator syntax
+@w{@code{@var{base} : @var{limit}}} or
+@w{@code{@var{base} : @var{increment} : @var{limit}}}.
 @seealso{linspace}
 @end deftypefn */)
 {