changeset 12578:f5a780d675a1

Clean up operator and function indices in documentation.
author Rik <octave@nomad.inbox5.com>
date Wed, 06 Apr 2011 11:44:21 -0700
parents 562e40e3d5db
children 0fed4935de94
files doc/ChangeLog doc/interpreter/diffeq.txi doc/interpreter/eval.txi doc/interpreter/plot.txi doc/interpreter/var.txi scripts/ChangeLog scripts/optimization/fminunc.m scripts/plot/isocolors.m scripts/plot/isonormals.m src/ChangeLog src/DLD-FUNCTIONS/dmperm.cc src/data.cc
diffstat 12 files changed, 23 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Mon Apr 04 20:15:32 2011 -0700
+++ b/doc/ChangeLog	Wed Apr 06 11:44:21 2011 -0700
@@ -1,3 +1,8 @@
+2011-04-06  Rik  <octave@nomad.inbox5.com>
+
+	* interpreter/diffeq.txi, interpreter/eval.txi, interpreter/plot.txi,
+	interpreter/var.txi: Clean up operator and function indices.
+
 2011-04-04  Rik  <octave@nomad.inbox5.com>
 
 	* interpreter/plot.txi: Add warning about single precision in FLTK.
--- a/doc/interpreter/diffeq.txi	Mon Apr 04 20:15:32 2011 -0700
+++ b/doc/interpreter/diffeq.txi	Wed Apr 06 11:44:21 2011 -0700
@@ -28,7 +28,7 @@
 * Differential-Algebraic Equations::  
 @end menu
 
-@cindex Differential Equations
+@cindex differential equations
 @cindex ODE
 @cindex DAE
 
--- a/doc/interpreter/eval.txi	Mon Apr 04 20:15:32 2011 -0700
+++ b/doc/interpreter/eval.txi	Wed Apr 06 11:44:21 2011 -0700
@@ -48,8 +48,6 @@
 Newton's method.
 
 @example
-@cindex Fordyce, A. P.
-@findex newtroot
 function result = newtroot (fname, x)
 
 # usage: newtroot (fname, x)
--- a/doc/interpreter/plot.txi	Mon Apr 04 20:15:32 2011 -0700
+++ b/doc/interpreter/plot.txi	Wed Apr 06 11:44:21 2011 -0700
@@ -2625,7 +2625,7 @@
 
 @node Application-defined Data
 @subsection Application-defined Data 
-@cindex Application-defined Data
+@cindex application-defined data
 
 Octave has a provision for attaching application-defined data to a graphics
 handle.  The data can be anything which is meaningful to the application, and
--- a/doc/interpreter/var.txi	Mon Apr 04 20:15:32 2011 -0700
+++ b/doc/interpreter/var.txi	Wed Apr 06 11:44:21 2011 -0700
@@ -28,10 +28,6 @@
 names, but it is seldom useful to have variables with names longer than
 about 30 characters.  The following are all valid variable names
 
-@cindex job hunting
-@cindex getting a good job
-@cindex flying high and fast
-
 @example
 @group
 x
--- a/scripts/ChangeLog	Mon Apr 04 20:15:32 2011 -0700
+++ b/scripts/ChangeLog	Wed Apr 06 11:44:21 2011 -0700
@@ -1,3 +1,8 @@
+2011-04-06  Rik  <octave@nomad.inbox5.com>
+
+	* optimization/fminunc.m, plot/isocolors.m, plot/isonormals.m:
+	Clean up operator and function indices.
+
 2011-04-04  Rik  <octave@nomad.inbox5.com>
 
 	* miscellaneous/symvar.m, miscellaneous/warning_ids.m,
--- a/scripts/optimization/fminunc.m	Mon Apr 04 20:15:32 2011 -0700
+++ b/scripts/optimization/fminunc.m	Wed Apr 06 11:44:21 2011 -0700
@@ -21,7 +21,7 @@
 ## -*- texinfo -*-
 ## @deftypefn  {Function File} {} fminunc (@var{fcn}, @var{x0})
 ## @deftypefnx {Function File} {} fminunc (@var{fcn}, @var{x0}, @var{options})
-## @deftypefnx {Function File} {[@var{x}, @var{fvec}, @var{info}, @var{output}, @var{grad}, @var{hess}]} = fminunc (@var{fcn}, @dots{})
+## @deftypefnx {Function File} {[@var{x}, @var{fvec}, @var{info}, @var{output}, @var{grad}, @var{hess}] =} fminunc (@var{fcn}, @dots{})
 ## Solve an unconstrained optimization problem defined by the function
 ## @var{fcn}.
 ## @var{fcn} should accepts a vector (array) defining the unknown variables,
--- a/scripts/plot/isocolors.m	Mon Apr 04 20:15:32 2011 -0700
+++ b/scripts/plot/isocolors.m	Wed Apr 06 11:44:21 2011 -0700
@@ -22,7 +22,7 @@
 ## @deftypefnx {Function File} {[@var{cd}] =} isocolors (@var{x}, @var{y}, @var{z}, @var{r}, @var{g}, @var{b}, @var{v})
 ## @deftypefnx {Function File} {[@var{cd}] =} isocolors (@var{r}, @var{g}, @var{b}, @var{v})
 ## @deftypefnx {Function File} {[@var{cd}] =} isocolors (@dots{}, @var{p})
-## @deftypefnx {Function File} isocolors (@dots{})
+## @deftypefnx {Function File} {} isocolors (@dots{})
 ##
 ## If called with one output argument and the first input argument
 ## @var{c} is a three-dimensional array that contains color values and
--- a/scripts/plot/isonormals.m	Mon Apr 04 20:15:32 2011 -0700
+++ b/scripts/plot/isonormals.m	Wed Apr 06 11:44:21 2011 -0700
@@ -22,7 +22,7 @@
 ## @deftypefnx {Function File} {[@var{n}] =} isonormals (@var{x}, @var{y}, @var{z}, @var{val}, @var{v})
 ## @deftypefnx {Function File} {[@var{n}] =} isonormals (@var{x}, @var{y}, @var{z}, @var{val}, @var{p})
 ## @deftypefnx {Function File} {[@var{n}] =} isonormals (@dots{}, "negate")
-## @deftypefnx {Function File} isonormals (@dots{}, @var{p})
+## @deftypefnx {Function File} {} isonormals (@dots{}, @var{p})
 ##
 ## If called with one output argument and the first input argument
 ## @var{val} is a three-dimensional array that contains the data for an
--- a/src/ChangeLog	Mon Apr 04 20:15:32 2011 -0700
+++ b/src/ChangeLog	Wed Apr 06 11:44:21 2011 -0700
@@ -1,3 +1,8 @@
+2011-04-06  Rik  <octave@nomad.inbox5.com>
+
+	* DLD-FUNCTIONS/dmperm.cc, data.cc: Clean up operator and function
+	indices.
+
 2011-04-04  Rik  <octave@nomad.inbox5.com>
 
 	* DLD-FUNCTIONS/nproc.cc: Spellcheck documentation for 3.4.1 release.
--- a/src/DLD-FUNCTIONS/dmperm.cc	Mon Apr 04 20:15:32 2011 -0700
+++ b/src/DLD-FUNCTIONS/dmperm.cc	Wed Apr 06 11:44:21 2011 -0700
@@ -191,7 +191,7 @@
 DEFUN_DLD (sprank, args, nargout,
   "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{p} =} sprank (@var{S})\n\
-@cindex Structural Rank\n\
+@cindex structural rank\n\
 \n\
 Calculate the structural rank of the sparse matrix @var{S}.  Note that\n\
 only the structure of the matrix is used in this calculation based on\n\
--- a/src/data.cc	Mon Apr 04 20:15:32 2011 -0700
+++ b/src/data.cc	Wed Apr 06 11:44:21 2011 -0700
@@ -4577,8 +4577,8 @@
 
 DEFUN (vec, args, ,
   "-*- texinfo -*-\n\
-@deftypefn  {Built-in Function} {} @var{v} = vec (@var{x})\n\
-@deftypefnx {Built-in Function} {} @var{v} = vec (@var{x}, @var{dim})\n\
+@deftypefn  {Built-in Function} {@var{v} =} vec (@var{x})\n\
+@deftypefnx {Built-in Function} {@var{v} =} vec (@var{x}, @var{dim})\n\
 Return the vector obtained by stacking the columns of the matrix @var{x}\n\
 one above the other.  Without @var{dim} this is equivalent to\n\
 @code{@var{x}(:)}.  If @var{dim} is supplied, the dimensions of @var{v}\n\