Mercurial > octave-nkf

changeset 15034:1116864ee270

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Fix for bad cross-referencing due to use of aliases in Texinfo. * data.cc (FInf): Use NaN form instead of nan for consistency in documentation and with cross-references. * data.cc (FNaN): Use Inf form instead of inf for consistency in documentation and with cross-references. * data.cc (Fnzmax): Re-order Seealso links to find related functions faster. * data.cc (Fmpower): Mention mtimes rather than times in Seealso links. * arith.txi: Add comment about why doc-anchors are needed. Remove anchors to lowercase nan and inf.
author Rik <rik@octave.org>
date Fri, 27 Jul 2012 09:11:49 -0700
parents 208db8873932
children a820a990968e ab18578c2ade
files doc/interpreter/arith.txi src/data.cc
diffstat 2 files changed, 7 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/arith.txi	Fri Jul 27 11:52:13 2012 -0400
+++ b/doc/interpreter/arith.txi	Fri Jul 27 09:11:49 2012 -0700
@@ -309,15 +309,14 @@
 
 @DOCSTRING(pi)
 
+@c Provide a Seealso link location for these objects in the documentation
 @anchor{doc-i}
 @anchor{doc-j}
 @anchor{doc-J}
 @DOCSTRING(I)
 
-@anchor{doc-inf}
 @DOCSTRING(Inf)
 
-@anchor{doc-nan}
 @DOCSTRING(NaN)
 
 @DOCSTRING(eps)
--- a/src/data.cc	Fri Jul 27 11:52:13 2012 -0400
+++ b/src/data.cc	Fri Jul 27 09:11:49 2012 -0700
@@ -2607,7 +2607,7 @@
 for sparse objects.  There are some cases of user created sparse objects\n\
 where the value returned by @dfn{nzmax} will not be the same as @dfn{nnz},\n\
 but in general they will give the same result.\n\
-@seealso{sparse, spalloc, nnz}\n\
+@seealso{nnz, spalloc, sparse}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -3950,7 +3950,7 @@
 arguments specify additional matrix dimensions.\n\
 The optional argument @var{class} specifies the return type and may be\n\
 either \"double\" or \"single\".\n\
-@seealso{isinf, nan}\n\
+@seealso{isinf, NaN}\n\
 @end deftypefn")
 {
   return fill_matrix (args, lo_ieee_inf_value (),
@@ -4009,7 +4009,7 @@
 arguments specify additional matrix dimensions.\n\
 The optional argument @var{class} specifies the return type and may be\n\
 either \"double\" or \"single\".\n\
-@seealso{isnan, inf}\n\
+@seealso{isnan, Inf}\n\
 @end deftypefn")
 {
   return fill_matrix (args, lo_ieee_nan_value (),
@@ -4314,7 +4314,7 @@
 @code{sqrt (-1)}.\n\
 @end ifnottex\n\
 \n\
-I, and its equivalents i, J, and j, are functions so any of the names may\n\
+I, and its equivalents i, j, and J, are functions so any of the names may\n\
 be reused for other purposes (such as i for a counter variable).\n\
 \n\
 When called with no arguments, return a scalar with the value @math{i}.  When\n\
@@ -4324,7 +4324,7 @@
 arguments specify additional matrix dimensions.\n\
 The optional argument @var{class} specifies the return type and may be\n\
 either \"double\" or \"single\".\n\
-@seealso{log, exp, e, pi, i, j}\n\
+@seealso{e, pi, log, exp, i, j, J}\n\
 @end deftypefn")
 {
   return fill_matrix (args, Complex (0.0, 1.0), "I");
@@ -5479,7 +5479,7 @@
 @deftypefn {Built-in Function} {} mpower (@var{x}, @var{y})\n\
 Return the matrix power operation of @var{x} raised to the @var{y} power.\n\
 This function and @w{@xcode{x ^ y}} are equivalent.\n\
-@seealso{power, times, plus, minus}\n\
+@seealso{power, mtimes, plus, minus}\n\
 @end deftypefn")
 {
   return binary_op_defun_body (octave_value::op_pow, args);