changeset 8817:03b7f618ab3d

include docstrings for new functions in the manual
author John W. Eaton <jwe@octave.org>
date Thu, 19 Feb 2009 15:39:19 -0500
parents a4a8f871be81
children 8dee145c777d
files doc/ChangeLog doc/interpreter/basics.txi doc/interpreter/data.txi doc/interpreter/debug.txi doc/interpreter/dynamic.txi doc/interpreter/eos.txi doc/interpreter/func.txi doc/interpreter/image.txi doc/interpreter/io.txi doc/interpreter/linalg.txi doc/interpreter/matrix.txi doc/interpreter/octave.texi doc/interpreter/optim.txi doc/interpreter/plot.txi doc/interpreter/sparse.txi doc/interpreter/strings.txi doc/interpreter/system.txi doc/interpreter/testfun.txi doc/interpreter/var.txi scripts/plot/comet.m
diffstat 20 files changed, 181 insertions(+), 40 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,18 @@
+2009-02-19  John W. Eaton  <jwe@octave.org>
+
+	* doc/interperter: Include @DOCSTRING commands for the following
+	functions: bicgstab, cgs, choldelete, cholinsert, cholshift,
+	clabel, comet, command_line_path, compass, contour3, ctranspose,
+	cylinder, dellistener, diffuse, edit, ellipsoid, fclear, feather,
+	fill, find_dir_in_path, finite, flag, info, is_absolute_filename,
+	is_rooted_relative_filename, isdebugmode, ishghandle, isnull,
+	issorted, make_absolute_filename, meshz, news,
+	octave_tmp_file_name, optimget, pareto, plotmatrix, plotyy,
+	qrshift, quiver3, re_read_readline_init_file, ribbon, rose,
+	rundemos, scatter, scatter3, slice, specular, sphere, spinmap,
+	stem3, strchr, strtrim, surfl, surfnorm, times, transpose,
+	treelayout, uminus, uplus, warranty, what, xlim, yes_or_no.
+
 2009-02-17  Thomas Treichl  <Thomas.Treichl@gmx.net>
 
 	* interpreter/install.txi: Add documentation for configure options
--- a/doc/interpreter/basics.txi
+++ b/doc/interpreter/basics.txi
@@ -332,6 +332,15 @@
 
 @DOCSTRING(lookfor)
 
+To see what is new in the current release of Octave, use the @code{news}
+function.
+
+@DOCSTRING(news)
+
+@DOCSTRING(info)
+
+@DOCSTRING(warranty)
+
 The following function can be used to change which programs are used
 for displaying the documentation, and where the documentation can be
 found.
@@ -633,6 +642,8 @@
 
 @DOCSTRING(read_readline_init_file)
 
+@DOCSTRING(re_read_readline_init_file)
+
 @node Customizing the Prompt
 @subsection Customizing the Prompt
 @cindex prompt customization
--- a/doc/interpreter/data.txi
+++ b/doc/interpreter/data.txi
@@ -191,6 +191,8 @@
 
 @DOCSTRING(isempty)
 
+@DOCSTRING(isnull)
+
 @DOCSTRING(sizeof)
 
 @DOCSTRING(size_equal)
--- a/doc/interpreter/debug.txi
+++ b/doc/interpreter/debug.txi
@@ -162,12 +162,14 @@
 
 @DOCSTRING(dbtype)
 
+You may also use @code{isdebugmode} to determine whether the debugger is
+currently active.
+
+@DOCSTRING(isdebugmode)
+
 Debug mode equally allows single line stepping through a function using
 the commands @code{dbstep}.
 
-@c leave dbnext undocumented
-
-@anchor{doc-dbnext}
 @DOCSTRING(dbstep)
 
 @node Call Stack
--- a/doc/interpreter/dynamic.txi
+++ b/doc/interpreter/dynamic.txi
@@ -615,9 +615,10 @@
 @end example
 
 @noindent
-which creates the matrix given in section @ref{Storage}.  Note that
-the compressed matrix format is not used at the time of the creation
-of the matrix itself, however it is used internally.
+which creates the matrix given in section
+@ref{Storage of Sparse Matrices}.  Note that the compressed matrix
+format is not used at the time of the creation of the matrix itself,
+however it is used internally.
 
 As previously mentioned, the values of the sparse matrix are stored
 in increasing column-major ordering.  Although the data passed by the
--- a/doc/interpreter/eos.txi
+++ b/doc/interpreter/eos.txi
@@ -503,7 +503,3 @@
 If you use Octave from within Emacs, these settings are best done in the
 @file{~/.emacs-octave} startup file (or the file pointed to by the Emacs
 variable @code{inferior-octave-startup-file}).
-
-@c Local Variables:
-@c TeX-command-default: "Texinfo"
-@c End:
--- a/doc/interpreter/func.txi
+++ b/doc/interpreter/func.txi
@@ -617,6 +617,8 @@
 
 @c FIXME -- note about time stamps on files in NFS environments?
 
+@DOCSTRING(edit)
+
 @DOCSTRING(mfilename)
 
 @DOCSTRING(ignore_function_time_stamp)
@@ -671,6 +673,10 @@
 
 @DOCSTRING(restoredefaultpath)
 
+@DOCSTRING(command_line_path)
+
+@DOCSTRING(find_dir_in_path)
+
 @node Subfunctions
 @subsection Subfunctions
 
--- a/doc/interpreter/image.txi
+++ b/doc/interpreter/image.txi
@@ -139,6 +139,8 @@
 
 @DOCSTRING(copper)
 
+@DOCSTRING(flag)
+
 @DOCSTRING(gray)
 
 @DOCSTRING(hot)
@@ -174,6 +176,11 @@
 
 @DOCSTRING(gmap40)
 
+You may use the @code{spinmap} function to cycle through the colors in
+the current colormap, displaying the changes for the current figure.
+
+@DOCSTRING(spinmap)
+
 @node Plotting on top of Images
 @section Plotting on top of Images
 
--- a/doc/interpreter/io.txi
+++ b/doc/interpreter/io.txi
@@ -125,6 +125,8 @@
 
 @DOCSTRING(menu)
 
+@DOCSTRING(yes_or_no)
+
 For @code{input}, the normal command line history and editing functions
 are available at the prompt.
 
@@ -975,7 +977,9 @@
 
 @DOCSTRING(tmpnam)
 
-@node EOF and Errors
+@DOCSTRING(octave_tmp_file_name)
+
+@node EOF and Errors, File Positioning, Temporary Files, C-Style I/O Functions
 @subsection End of File and Errors
 
 Once a file has been opened its status can be acquired.  As an example
@@ -1003,6 +1007,8 @@
 
 @DOCSTRING(ferror)
 
+@DOCSTRING(fclear)
+
 @DOCSTRING(freport)
 
 @node File Positioning
--- a/doc/interpreter/linalg.txi
+++ b/doc/interpreter/linalg.txi
@@ -29,6 +29,7 @@
 * Basic Matrix Functions::      
 * Matrix Factorizations::       
 * Functions of a Matrix::       
+* Specialized Solvers::
 @end menu
 
 @node Techniques used for Linear Algebra
@@ -128,6 +129,12 @@
 
 @DOCSTRING(cholupdate)
 
+@DOCSTRING(cholinsert)
+
+@DOCSTRING(choldelete)
+
+@DOCSTRING(cholshift)
+
 @DOCSTRING(hess)
 
 @DOCSTRING(lu)
@@ -140,6 +147,8 @@
 
 @DOCSTRING(qrdelete)
 
+@DOCSTRING(qrshift)
+
 @DOCSTRING(qz)
 
 @DOCSTRING(qzhess)
@@ -168,3 +177,10 @@
 @DOCSTRING(kron)
 
 @DOCSTRING(syl)
+
+@node Specialized Solvers
+@section Specialized Solvers
+
+@DOCSTRING(bicgstab)
+
+@DOCSTRING(cgs)
--- a/doc/interpreter/matrix.txi
+++ b/doc/interpreter/matrix.txi
@@ -118,6 +118,8 @@
 
 @DOCSTRING(sortrows)
 
+@DOCSTRING(issorted)
+
 Since the @code{sort} function does not allow sort keys to be specified,
 it can't be used to order the rows of a matrix according to the values
 of the elements in various columns@footnote{For example, to first sort
--- a/doc/interpreter/octave.texi
+++ b/doc/interpreter/octave.texi
@@ -193,6 +193,7 @@
 * Function Index::              An item for each documented function.
 * Operator Index::              An item for each documented operator.
 
+@c FIXME -- is the detailed node listing up to date?
 @detailmenu
  --- The Detailed Node Listing ---
 
--- a/doc/interpreter/optim.txi
+++ b/doc/interpreter/optim.txi
@@ -140,3 +140,5 @@
 @DOCSTRING(lsqnonneg)
 
 @DOCSTRING(optimset)
+
+@DOCSTRING(optimget)
--- a/doc/interpreter/plot.txi
+++ b/doc/interpreter/plot.txi
@@ -70,6 +70,11 @@
 
 @DOCSTRING(plot)
 
+The @code{plotyy} function may be used to create a plot with two
+independent y axes.
+
+@DOCSTRING(plotyy)
+
 The functions @code{semilogx}, @code{semilogy}, and @code{loglog} are
 similar to the @code{plot} function, but produce plots in which one or
 both of the axes use log scales.
@@ -108,6 +113,18 @@
 
 @DOCSTRING(stem)
 
+@DOCSTRING(stem3)
+
+@DOCSTRING(scatter)
+
+@DOCSTRING(scatter3)
+
+@DOCSTRING(plotmatrix)
+
+@DOCSTRING(pareto)
+
+@DOCSTRING(rose)
+
 The @code{contour}, @code{contourf} and @code{contourc} functions
 produce two-dimensional contour plots from three dimensional data.
 
@@ -117,6 +134,8 @@
 
 @DOCSTRING(contourc)
 
+@DOCSTRING(contour3)
+
 The @code{errorbar}, @code{semilogxerr}, @code{semilogyerr}, and
 @code{loglogerr} functions produce plots with error bar markers.  For
 example,
@@ -167,10 +186,18 @@
 
 @DOCSTRING(quiver)
 
+@DOCSTRING(quiver3)
+
+@DOCSTRING(compass)
+
+@DOCSTRING(feather)
+
 @DOCSTRING(pcolor)
 
 @DOCSTRING(area)
 
+@DOCSTRING(comet)
+
 The axis function may be used to change the axis limits of an existing
 plot and various other axis properties, such as the aspect ratio and the
 appearance of tic marks.
@@ -182,6 +209,13 @@
 
 @DOCSTRING(caxis)
 
+The @code{xlim}, @code{ylim}, and @code{zlim} functions may be used to
+get or set individual axis limits.  Each has the same form.
+
+@anchor{doc-ylim}
+@anchor{doc-zlim}
+@DOCSTRING(xlim)
+
 @menu
 * Two-dimensional Function Plotting::
 @end menu
@@ -276,12 +310,22 @@
 
 @DOCSTRING(meshc)
 
+@DOCSTRING(meshz)
+
 @DOCSTRING(hidden)
 
 @DOCSTRING(surf)
 
 @DOCSTRING(surfc)
 
+@DOCSTRING(surfl)
+
+@DOCSTRING(surfnorm)
+
+@DOCSTRING(diffuse)
+
+@DOCSTRING(specular)
+
 @DOCSTRING(meshgrid)
 
 @DOCSTRING(ndgrid)
@@ -290,10 +334,15 @@
 
 @DOCSTRING(view)
 
+@DOCSTRING(slice)
+
+@DOCSTRING(ribbon)
+
 @DOCSTRING(shading)
 
 @menu
 * Three-dimensional Function Plotting::
+* Three-dimensional Geometric Shapes::
 @end menu
 
 @node Three-dimensional Function Plotting
@@ -309,6 +358,15 @@
 
 @DOCSTRING(ezsurfc)
 
+@node Three-dimensional Geometric Shapes
+@subsubsection Three-dimensional Geometric Shapes
+
+@DOCSTRING(cylinder)
+
+@DOCSTRING(sphere)
+
+@DOCSTRING(ellipsoid)
+
 @node Plot Annotations
 @subsection Plot Annotations
 
@@ -343,6 +401,8 @@
 @anchor{doc-zlabel}
 @DOCSTRING(xlabel)
 
+@DOCSTRING(clabel)
+
 @DOCSTRING(box)
 
 @DOCSTRING(grid)
@@ -508,6 +568,8 @@
 
 @DOCSTRING(ishandle)
 
+@DOCSTRING(ishghandle)
+
 @DOCSTRING(isfigure)
 
 The function @code{gcf} returns an index to the current figure object,
@@ -596,6 +658,8 @@
 
 @DOCSTRING(patch)
 
+@DOCSTRING(fill)
+
 @DOCSTRING(surface)
 
 By default, Octave refreshes the plot window when a prompt is printed,
@@ -1508,6 +1572,8 @@
 
 @DOCSTRING(addlistener)
 
+@DOCSTRING(dellistener)
+
 An example of the use of these two functions might be
 
 @example
--- a/doc/interpreter/sparse.txi
+++ b/doc/interpreter/sparse.txi
@@ -27,13 +27,13 @@
 @chapter Sparse Matrices
 
 @menu
-* Basics:: The Creation and Manipulation of Sparse Matrices
-* Sparse Linear Algebra:: Linear Algebra on Sparse Matrices
-* Iterative Techniques:: Iterative Techniques applied to Sparse Matrices
-* Real Life Example:: Real Life Example of the use of Sparse Matrices
+* Basics::                      Creation and Manipulation of Sparse Matrices
+* Sparse Linear Algebra::       Linear Algebra on Sparse Matrices
+* Iterative Techniques::        Iterative Techniques
+* Real Life Example::           Using Sparse Matrices
 @end menu
 
-@node Basics, Sparse Linear Algebra, Sparse Matrices, Sparse Matrices
+@node Basics
 @section The Creation and Manipulation of Sparse Matrices
 
 The size of mathematical problems that can be treated at any particular
@@ -56,13 +56,13 @@
 on them.
 
 @menu
-* Storage:: Storage of Sparse Matrices
-* Creation:: Creating Sparse Matrices
-* Information:: Finding out Information about Sparse Matrices
-* Operators and Functions:: Basic Operators and Functions on Sparse Matrices
+* Storage of Sparse Matrices::
+* Creating Sparse Matrices::
+* Information::
+* Operators and Functions::
 @end menu
 
-@node Storage, Creation, Basics, Basics
+@node Storage of Sparse Matrices
 @subsection Storage of Sparse Matrices
 
 It is not strictly speaking necessary for the user to understand how
@@ -166,7 +166,7 @@
 such as concatenating two sparse matrices together easier and faster, however
 it adds complexity and speed problems elsewhere.
 
-@node Creation, Information, Storage, Basics
+@node Creating Sparse Matrices
 @subsection Creating Sparse Matrices
 
 There are several means to create sparse matrix.
@@ -303,7 +303,7 @@
 you are referred to chapter @ref{Dynamically Linked Functions}, to have
 a full description of the techniques involved.
 
-@node Information, Operators and Functions, Creation, Basics
+@node Information
 @subsection Finding out Information about Sparse Matrices
 
 There are a number of functions that allow information concerning
@@ -421,16 +421,18 @@
 
 @DOCSTRING(treeplot)
 
-@node Operators and Functions, , Information, Basics
+@DOCSTRING(treelayout)
+
+@node Operators and Functions
 @subsection Basic Operators and Functions on Sparse Matrices
 
 @menu
-* Functions:: Sparse Functions
-* ReturnType:: The Return Types of Operators and Functions
-* MathConsiderations:: Mathematical Considerations
+* Sparse Functions::            
+* Return Types of Operators and Functions::  
+* Mathematical Considerations::  
 @end menu
 
-@node Functions, ReturnType, Operators and Functions, Operators and Functions
+@node Sparse Functions
 @subsubsection Sparse Functions
 
 An important consideration in the use of the sparse functions of
@@ -491,7 +493,7 @@
 supplied with these functions within Octave itself for further
 details.
 
-@node ReturnType, MathConsiderations, Functions, Operators and Functions
+@node Return Types of Operators and Functions
 @subsubsection The Return Types of Operators and Functions
 
 The two basic reasons to use sparse matrices are to reduce the memory 
@@ -550,7 +552,7 @@
 Note that the @code{sparse_auto_mutate} option is incompatible with
 @sc{Matlab}, and so it is off by default.
 
-@node MathConsiderations, , ReturnType, Operators and Functions
+@node Mathematical Considerations
 @subsubsection Mathematical Considerations
 
 The attempt has been made to make sparse matrices behave in exactly the
@@ -722,7 +724,7 @@
 
 @DOCSTRING(symrcm)
 
-@node Sparse Linear Algebra, Iterative Techniques, Basics, Sparse Matrices
+@node Sparse Linear Algebra
 @section Linear Algebra on Sparse Matrices
 
 Octave includes a polymorphic solver for sparse matrices, where 
@@ -840,7 +842,7 @@
 
 @DOCSTRING(svds)
 
-@node Iterative Techniques, Real Life Example, Sparse Linear Algebra, Sparse Matrices
+@node Iterative Techniques
 @section Iterative Techniques applied to sparse matrices
 
 The left division @code{\} and right division @code{/} operators,
@@ -861,7 +863,7 @@
 
 @DOCSTRING(luinc)
 
-@node Real Life Example, , Iterative Techniques, Sparse Matrices
+@node Real Life Example
 @section Real Life Example of the use of Sparse Matrices
 
 A common application for sparse matrices is in the solution of Finite
--- a/doc/interpreter/strings.txi
+++ b/doc/interpreter/strings.txi
@@ -412,10 +412,14 @@
 
 @DOCSTRING(deblank)
 
+@DOCSTRING(strtrim)
+
 @DOCSTRING(strtrunc)
 
 @DOCSTRING(findstr)
 
+@DOCSTRING(strchr)
+
 @DOCSTRING(index)
 
 @DOCSTRING(rindex)
--- a/doc/interpreter/system.txi
+++ b/doc/interpreter/system.txi
@@ -212,6 +212,12 @@
 
 @DOCSTRING(P_tmpdir)
 
+@DOCSTRING(is_absolute_filename)
+
+@DOCSTRING(is_rooted_relative_filename)
+
+@DOCSTRING(make_absolute_filename)
+
 @node File Archiving Utilities
 @section File Archiving Utilities
 
--- a/doc/interpreter/testfun.txi
+++ b/doc/interpreter/testfun.txi
@@ -301,11 +301,8 @@
 
 @DOCSTRING(demo)
 
+@DOCSTRING(rundemos)
+
 @DOCSTRING(example)
 
 @DOCSTRING(speed)
-
-
-@c Local Variables: ***
-@c Mode: texinfo ***
-@c End: ***
--- a/doc/interpreter/var.txi
+++ b/doc/interpreter/var.txi
@@ -368,3 +368,4 @@
 
 @DOCSTRING(which)
 
+@DOCSTRING(what)
--- a/scripts/plot/comet.m
+++ b/scripts/plot/comet.m
@@ -29,8 +29,6 @@
 ##
 ## If @var{ax} is specified the animition is produced in that axis rather than
 ## the @code{gca}.
-## 
-## @seealso{comet3}
 ## @end deftypefn
 
 ## Author: Ben Abbott bpabbott@mac.com