Mercurial > octave
changeset 28961:d9d028b479ac
doc: Use @code{} within alternate text for @xref,@pxref macros in libinterp/
* debug.cc, error.cc, qz.cc, regexp.cc, sub2ind.cc:
Use @code{} within alternate text for @xref,@pxref macros.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 19 Oct 2020 09:49:03 -0700 |
| parents | e5a1087f15d5 |
| children | 90c39bbbe5cd |
| files | libinterp/corefcn/debug.cc libinterp/corefcn/error.cc libinterp/corefcn/qz.cc libinterp/corefcn/regexp.cc libinterp/corefcn/sub2ind.cc |
| diffstat | 5 files changed, 12 insertions(+), 11 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/debug.cc Mon Oct 19 09:44:02 2020 -0700 +++ b/libinterp/corefcn/debug.cc Mon Oct 19 09:49:03 2020 -0700 @@ -293,7 +293,7 @@ @item event An event such as @code{error}, @code{interrupt}, or @code{warning} -(@pxref{XREFdbstop,,dbstop} for details). +(@pxref{XREFdbstop,,@code{dbstop}} for details). @end table When called without a line number specification all breakpoints in the named
--- a/libinterp/corefcn/error.cc Mon Oct 19 09:44:02 2020 -0700 +++ b/libinterp/corefcn/error.cc Mon Oct 19 09:49:03 2020 -0700 @@ -1397,7 +1397,7 @@ 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 form @qcode{"NAMESPACE:WARNING-NAME"}. Octave's own warnings use the -@qcode{"Octave"} namespace (@pxref{XREFwarning_ids,,warning_ids}). For +@qcode{"Octave"} namespace (@pxref{XREFwarning_ids,,@code{warning_ids}}). For example: @example
--- a/libinterp/corefcn/qz.cc Mon Oct 19 09:44:02 2020 -0700 +++ b/libinterp/corefcn/qz.cc Mon Oct 19 09:49:03 2020 -0700 @@ -162,9 +162,9 @@ @end enumerate Note: @code{qz} performs permutation balancing, but not scaling -(@pxref{XREFbalance,,balance}), which may be lead to less accurate results than -@code{eig}. The order of output arguments was selected for compatibility with -@sc{matlab}. +(@pxref{XREFbalance,,@code{balance}}), which may be lead to less accurate +results than @code{eig}. The order of output arguments was selected for +compatibility with @sc{matlab}. @seealso{eig, ordeig, balance, lu, chol, hess, qr, qzhess, schur, svd} @end deftypefn */) {
--- a/libinterp/corefcn/regexp.cc Mon Oct 19 09:44:02 2020 -0700 +++ b/libinterp/corefcn/regexp.cc Mon Oct 19 09:49:03 2020 -0700 @@ -1199,7 +1199,8 @@ Search for @var{pat} in UTF-8 encoded @var{str} and return the positions and substrings of any matches, or empty values if there are none. -@xref{XREFregexp,,regexp}, for details on the syntax of the search pattern. +@xref{XREFregexp,,@code{regexp}}, for details on the syntax of the search +pattern. @seealso{regexp} @end deftypefn */) { @@ -1396,7 +1397,7 @@ Replace occurrences of pattern @var{pat} in @var{string} with @var{repstr}. The pattern is a regular expression as documented for @code{regexp}. -@xref{XREFregexp,,regexp}. +@xref{XREFregexp,,@code{regexp}}. All strings must be UTF-8 encoded.
--- a/libinterp/corefcn/sub2ind.cc Mon Oct 19 09:44:02 2020 -0700 +++ b/libinterp/corefcn/sub2ind.cc Mon Oct 19 09:49:03 2020 -0700 @@ -68,8 +68,8 @@ Convert subscripts to linear indices. The input @var{dims} is a dimension vector where each element is the size of -the array in the respective dimension (@pxref{XREFsize,,size}). The remaining -inputs are scalars or vectors of subscripts to be converted. +the array in the respective dimension (@pxref{XREFsize,,@code{size}}). The +remaining inputs are scalars or vectors of subscripts to be converted. The output vector @var{ind} contains the converted linear indices. @@ -193,8 +193,8 @@ Convert linear indices to subscripts. The input @var{dims} is a dimension vector where each element is the size of -the array in the respective dimension (@pxref{XREFsize,,size}). The second -input @var{ind} contains linear indies to be converted. +the array in the respective dimension (@pxref{XREFsize,,@code{size}}). The +second input @var{ind} contains linear indies to be converted. The outputs @var{s1}, @dots{}, @var{sN} contain the converted subscripts.