changeset 30377:26f2daafa270 stable

doc: Use consistent styling for @ref, @xref, @pxref statements. * data.cc, error.cc, input.cc, jsondecode.cc, mappers.cc, pager.cc, setappdata.m, open.m, fminbnd.m, fzero.m, camorbit.m, camup.m, stem3.m: Use consistent styling for @ref, @xref, @pxref statements.
author Rik <rik@octave.org>
date Fri, 26 Nov 2021 18:13:08 -0800
parents c23dafed5ffd
children c66cc7e61f84 363fb10055df
files libinterp/corefcn/data.cc libinterp/corefcn/error.cc libinterp/corefcn/input.cc libinterp/corefcn/jsondecode.cc libinterp/corefcn/mappers.cc libinterp/corefcn/pager.cc scripts/gui/setappdata.m scripts/miscellaneous/open.m scripts/optimization/fminbnd.m scripts/optimization/fzero.m scripts/plot/appearance/camorbit.m scripts/plot/appearance/camup.m scripts/plot/draw/stem3.m
diffstat 13 files changed, 23 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/data.cc	Fri Nov 26 17:39:45 2021 -0800
+++ b/libinterp/corefcn/data.cc	Fri Nov 26 18:13:08 2021 -0800
@@ -6765,7 +6765,7 @@
 When given the identifier @var{id} of a specific timer, return the number of
 seconds elapsed since the timer @var{id} was initialized.
 
-@xref{XREFtic, , tic}, for examples of the use of @code{tic}/@code{toc}.
+@xref{XREFtic,,@code{tic}}, for examples of the use of @code{tic}/@code{toc}.
 
 @seealso{tic, cputime}
 @end deftypefn */)
--- a/libinterp/corefcn/error.cc	Fri Nov 26 17:39:45 2021 -0800
+++ b/libinterp/corefcn/error.cc	Fri Nov 26 18:13:08 2021 -0800
@@ -1386,7 +1386,7 @@
 print a traceback of all the function calls leading to the warning.  If the
 warning message does end in a newline character, Octave will suppress the
 traceback messages as it returns control to the top level.  For more details
-and examples, see @ref{XREFerror,,error}.
+and examples, @pxref{XREFerror,,@code{error}}.
 
 The optional warning identifier @var{id} allows users to enable or disable
 warnings tagged by this identifier.  A message identifier is a string of the
--- a/libinterp/corefcn/input.cc	Fri Nov 26 17:39:45 2021 -0800
+++ b/libinterp/corefcn/input.cc	Fri Nov 26 18:13:08 2021 -0800
@@ -1342,7 +1342,7 @@
 If @var{file} is omitted, read the default initialization file
 (normally @file{~/.inputrc}).
 
-@xref{Readline Init File, , , readline, GNU Readline Library},
+@xref{Readline Init File,,,readline, GNU Readline Library},
 for details.
 @seealso{readline_re_read_init_file}
 @end deftypefn */)
@@ -1369,7 +1369,7 @@
 @deftypefn {} {} readline_re_read_init_file ()
 Re-read the last readline library initialization file that was read.
 
-@xref{Readline Init File, , , readline, GNU Readline Library},
+@xref{Readline Init File,,,readline, GNU Readline Library},
 for details.
 @seealso{readline_read_init_file}
 @end deftypefn */)
--- a/libinterp/corefcn/jsondecode.cc	Fri Nov 26 17:39:45 2021 -0800
+++ b/libinterp/corefcn/jsondecode.cc	Fri Nov 26 18:13:08 2021 -0800
@@ -498,8 +498,8 @@
 decoding @var{JSON_txt}.
 
 For more information about the options @qcode{"ReplacementStyle"} and
-@qcode{"Prefix"}, see
-@ref{XREFmatlab_lang_makeValidName,,matlab.lang.makeValidName}.
+@qcode{"Prefix"},
+@pxref{XREFmatlab_lang_makeValidName,,@code{matlab.lang.makeValidName}}.
 
 If the value of the option @qcode{"makeValidName"} is false then names
 will not be changed by @code{matlab.lang.makeValidName} and the
--- a/libinterp/corefcn/mappers.cc	Fri Nov 26 17:39:45 2021 -0800
+++ b/libinterp/corefcn/mappers.cc	Fri Nov 26 18:13:08 2021 -0800
@@ -944,7 +944,7 @@
 @end ifnottex
 for each element of @var{x}.
 
-To compute the matrix exponential, see @ref{Linear Algebra}.
+To compute the matrix exponential, @pxref{Linear Algebra}.
 @seealso{log}
 @end deftypefn */)
 {
@@ -1699,7 +1699,7 @@
 @end ifnottex
 for each element of @var{x}.
 
-To compute the matrix logarithm, see @ref{Linear Algebra}.
+To compute the matrix logarithm, @pxref{Linear Algebra}.
 @seealso{exp, log1p, log2, log10, logspace}
 @end deftypefn */)
 {
@@ -1941,7 +1941,7 @@
 otherwise.
 
 This behavior is consistent with the other logical functions.
-See @ref{Logical Values}.  The behavior differs from the C language function
+@xref{Logical Values}.  The behavior differs from the C language function
 which returns nonzero if the sign bit is set.
 
 This is not the same as @code{x < 0.0}, because IEEE 754 floating point
@@ -2040,7 +2040,7 @@
 
 If @var{x} is negative, a complex result is returned.
 
-To compute the matrix square root, see @ref{Linear Algebra}.
+To compute the matrix square root, @pxref{Linear Algebra}.
 @seealso{realsqrt, nthroot}
 @end deftypefn */)
 {
--- a/libinterp/corefcn/pager.cc	Fri Nov 26 17:39:45 2021 -0800
+++ b/libinterp/corefcn/pager.cc	Fri Nov 26 18:13:08 2021 -0800
@@ -696,7 +696,7 @@
 pager.
 
 This allows you to view one screenful at a time.  Some pagers
-(such as @code{less}---see @ref{Installation}) are also capable of moving
+(such as @code{less}---@pxref{Installation}) are also capable of moving
 backward on the output.
 
 When called from inside a function with the @qcode{"local"} option, the
--- a/scripts/gui/setappdata.m	Fri Nov 26 17:39:45 2021 -0800
+++ b/scripts/gui/setappdata.m	Fri Nov 26 18:13:08 2021 -0800
@@ -35,8 +35,8 @@
 ##
 ## Multiple @var{name}/@var{value} pairs can be specified.  Alternatively, a
 ## cell array of @var{names} and a corresponding cell array of @var{values} can
-## be specified.  Details on obtaining a list of valid application data
-## properties can be found in @ref{XREFgetappdata, ,getappdata}.
+## be specified.  For details on obtaining a list of valid application data
+## properties, @pxref{XREFgetappdata,,@code{getappdata}}.
 ##
 ## @seealso{getappdata, isappdata, rmappdata, guidata, get, set, getpref,
 ## setpref}
--- a/scripts/miscellaneous/open.m	Fri Nov 26 17:39:45 2021 -0800
+++ b/scripts/miscellaneous/open.m	Fri Nov 26 18:13:08 2021 -0800
@@ -43,7 +43,8 @@
 ## @xref{XREFload,,load function}.
 ##
 ## @item .ofig
-## Open the figure with @code{hgload}.  @xref{XREFhgload,,hgload function}.
+## Open the figure with @code{hgload}.  
+## @xref{XREFhgload,,hgload function}.
 ##
 ## @item .fig, .ofig
 ## Load the figure
--- a/scripts/optimization/fminbnd.m	Fri Nov 26 17:39:45 2021 -0800
+++ b/scripts/optimization/fminbnd.m	Fri Nov 26 18:13:08 2021 -0800
@@ -51,7 +51,8 @@
 ## @qcode{"TolX"} specifies the termination tolerance for the solution @var{x}.
 ## The default is @code{1e-4}.
 ##
-## For a description of the other options, see @ref{XREFoptimset,,optimset}.
+## For a description of the other options,
+## @pxref{XREFoptimset,,@code{optimset}}.
 ## To initialize an options structure with default values for @code{fminbnd}
 ## use @code{options = optimset ("fminbnd")}.
 ##
--- a/scripts/optimization/fzero.m	Fri Nov 26 17:39:45 2021 -0800
+++ b/scripts/optimization/fzero.m	Fri Nov 26 18:13:08 2021 -0800
@@ -61,7 +61,8 @@
 ## @qcode{"TolX"} specifies the termination tolerance for the solution @var{x}.
 ## The default value is @code{eps}.
 ##
-## For a description of the other options, see @ref{XREFoptimset,,optimset}.
+## For a description of the other options,
+## @pxref{XREFoptimset,,@code{optimset}}.
 ## To initialize an options structure with default values for @code{fzero} use
 ## @code{options = optimset ("fzero")}.
 ##
--- a/scripts/plot/appearance/camorbit.m	Fri Nov 26 17:39:45 2021 -0800
+++ b/scripts/plot/appearance/camorbit.m	Fri Nov 26 18:13:08 2021 -0800
@@ -95,7 +95,7 @@
 ## (Note: the rotation by @var{phi} is unaffected by @qcode{"camera"}.)
 ##
 ## The @code{camorbit} command modifies two camera properties:
-## @ref{XREFcampos,,campos} and @ref{XREFcamup,,camup}.
+## @ref{XREFcampos,,@code{campos}} and @ref{XREFcamup,,@code{camup}}.
 ##
 ## By default, this command affects the current axis; alternatively, an axis
 ## can be specified by the optional argument @var{hax}.
--- a/scripts/plot/appearance/camup.m	Fri Nov 26 17:39:45 2021 -0800
+++ b/scripts/plot/appearance/camup.m	Fri Nov 26 18:13:08 2021 -0800
@@ -71,7 +71,7 @@
 ## A consequence is that ``pulling back'' on the up vector does not pitch the
 ## camera view (as that would require changing the target).  Setting the up
 ## vector is thus typically used only to roll the camera.  A more intuitive
-## command for this purpose is @ref{XREFcamroll,,camroll}.
+## command for this purpose is @ref{XREFcamroll,,@code{camroll}}.
 ##
 ## Finally, we can reset the up vector to automatic mode:
 ##
--- a/scripts/plot/draw/stem3.m	Fri Nov 26 17:39:45 2021 -0800
+++ b/scripts/plot/draw/stem3.m	Fri Nov 26 18:13:08 2021 -0800
@@ -50,8 +50,8 @@
 ##
 ## The optional return value @var{h} is a handle to the @nospell{"stem series"}
 ## hggroup containing the line and marker objects used for the plot.
-## @xref{XREFstem,,stem}, for a description of the @nospell{"stem series"}
-## object.
+## @xref{XREFstem,,@code{stem}}, for a description of the
+## @nospell{"stem series"} object.
 ##
 ## Example:
 ##