Mercurial > hg > octave-terminal
changeset 11152:39ae406df598
Improve docstrings for functions found in undocumented list.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 24 Oct 2010 07:33:34 -0700 |
parents | 0c38b45ab49c |
children | 3ddf14b8196f |
files | scripts/ChangeLog scripts/miscellaneous/compare_versions.m scripts/plot/ylabel.m scripts/plot/ylim.m scripts/plot/zlabel.m scripts/plot/zlim.m scripts/specfun/betai.m scripts/specfun/gammai.m src/ChangeLog src/DLD-FUNCTIONS/tril.cc src/syscalls.cc |
diffstat | 11 files changed, 24 insertions(+), 95 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,8 @@ +2010-10-24 Rik <octave@nomad.inbox5.com> + + * miscellaneous/compare_versions.m, plot/ylabel.m, plot/ylim.m, + plot/zlabel.m, plot/zlim.m: Docstring improvements. + 2010-10-24 Rik <octave@nomad.inbox5.com> * specfun/module.mk, deprecated/module.mk, deprecated/betai.m,
--- a/scripts/miscellaneous/compare_versions.m +++ b/scripts/miscellaneous/compare_versions.m @@ -18,16 +18,16 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} compare_versions (@var{v1}, @var{v2}, @var{operator}) -## Compares to version strings using the given @var{operator}. +## Compare two version strings using the given @var{operator}. ## ## This function assumes that versions @var{v1} and @var{v2} are ## arbitrarily long strings made of numeric and period characters ## possibly followed by an arbitrary string (e.g., "1.2.3", "0.3", ## "0.1.2+", or "1.2.3.4-test1"). ## -## The version is first split into the numeric and the character parts -## then the parts are padded to be the same length (i.e., "1.1" would be -## padded to be like "1.1.0" when being compared with "1.1.1", and +## The version is first split into numeric and character portions +## and then the parts are padded to be the same length (i.e., "1.1" would be +## padded to be "1.1.0" when being compared with "1.1.1", and ## separately, the character parts of the strings are padded with ## nulls). ## @@ -63,7 +63,7 @@ ## not equal ## @end itemize ## -## Note that version "1.1-test2" would compare as greater than +## Note that version "1.1-test2" will compare as greater than ## "1.1-test10". Also, since the numeric part is compared first, "a" ## compares less than "1a" because the second string starts with a ## numeric part even though double("a") is greater than double("1").
--- a/scripts/plot/ylabel.m +++ b/scripts/plot/ylabel.m @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} ylabel (@var{string}) ## @deftypefnx {Function File} {} ylabel (@var{h}, @var{string}) -## @seealso{xlabel}. +## @seealso{xlabel} ## @end deftypefn ## Author: jwe
--- a/scripts/plot/ylim.m +++ b/scripts/plot/ylim.m @@ -17,14 +17,14 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{xl} =} ylim () -## @deftypefnx {Function File} {} ylim (@var{xl}) +## @deftypefn {Function File} {@var{yl} =} ylim () +## @deftypefnx {Function File} {} ylim (@var{yl}) ## @deftypefnx {Function File} {@var{m} =} ylim ('mode') ## @deftypefnx {Function File} {} ylim (@var{m}) ## @deftypefnx {Function File} {} ylim (@var{h}, @dots{}) ## Get or set the limits of the y-axis of the current plot. Called without ## arguments @code{ylim} returns the y-axis limits of the current plot. -## If passed a two element vector @var{xl}, the limits of the y-axis are set +## If passed a two element vector @var{yl}, the limits of the y-axis are set ## to this value. ## ## The current mode for calculation of the y-axis can be returned with a
--- a/scripts/plot/zlabel.m +++ b/scripts/plot/zlabel.m @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} zlabel (@var{string}) ## @deftypefnx {Function File} {} zlabel (@var{h}, @var{string}) -## @seealso{xlabel}. +## @seealso{xlabel} ## @end deftypefn ## Author: jwe
--- a/scripts/plot/zlim.m +++ b/scripts/plot/zlim.m @@ -17,14 +17,14 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{xl} =} zlim () -## @deftypefnx {Function File} {} zlim (@var{xl}) +## @deftypefn {Function File} {@var{zl} =} zlim () +## @deftypefnx {Function File} {} zlim (@var{zl}) ## @deftypefnx {Function File} {@var{m} =} zlim ('mode') ## @deftypefnx {Function File} {} zlim (@var{m}) ## @deftypefnx {Function File} {} zlim (@var{h}, @dots{}) ## Get or set the limits of the z-axis of the current plot. Called without ## arguments @code{zlim} returns the z-axis limits of the current plot. -## If passed a two element vector @var{xl}, the limits of the z-axis are set +## If passed a two element vector @var{zl}, the limits of the z-axis are set ## to this value. ## ## The current mode for calculation of the z-axis can be returned with a
deleted file mode 100644 --- a/scripts/specfun/betai.m +++ /dev/null @@ -1,40 +0,0 @@ -## Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2005, 2006, -## 2007 John W. Eaton -## -## This file is part of Octave. -## -## Octave is free software; you can redistribute it and/or modify it -## under the terms of the GNU General Public License as published by -## the Free Software Foundation; either version 3 of the License, or (at -## your option) any later version. -## -## Octave is distributed in the hope that it will be useful, but -## WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -## General Public License for more details. -## -## You should have received a copy of the GNU General Public License -## along with Octave; see the file COPYING. If not, see -## <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @deftypefn {Function File} {} betai (@var{a}, @var{b}, @var{x}) -## This function is provided for compatibility with older versions of -## Octave. New programs should use betainc instead. -## -## @code{betai (@var{a}, @var{b}, @var{x})} is the same as @code{betainc -## (@var{x}, @var{a}, @var{b})}. -## @end deftypefn - -## Author: jwe -## Created: 30 Jan 1998 - -function retval = betai (a, b, x) - - if (nargin == 3) - retval = betainc (x, a, b); - else - print_usage (); - endif - -endfunction
deleted file mode 100644 --- a/scripts/specfun/gammai.m +++ /dev/null @@ -1,40 +0,0 @@ -## Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2005, 2006, -## 2007 John W. Eaton -## -## This file is part of Octave. -## -## Octave is free software; you can redistribute it and/or modify it -## under the terms of the GNU General Public License as published by -## the Free Software Foundation; either version 3 of the License, or (at -## your option) any later version. -## -## Octave is distributed in the hope that it will be useful, but -## WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -## General Public License for more details. -## -## You should have received a copy of the GNU General Public License -## along with Octave; see the file COPYING. If not, see -## <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @deftypefn {Function File} {} gammai (@var{a}, @var{x}) -## This function is provided for compatibility with older versions of -## Octave. New programs should use @code{gammainc} instead. -## -## @code{gammai (@var{a}, @var{x})} is the same as @code{gammainc -## (@var{x}, @var{a})}. -## @end deftypefn - -## Author: jwe -## Created: 30 Jan 1998 - -function retval = gammai (a, x) - - if (nargin == 2) - retval = gammainc (x, a); - else - print_usage (); - endif - -endfunction
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,7 @@ +2010-10-24 Rik <octave@nomad.inbox5.com> + + * DLD-FUNCTIONS/tril.cc, syscalls.cc: Docstring improvements. + 2010-10-24 Rik <octave@nomad.inbox5.com> * variables.cc: Deprecate is_global function
--- a/src/DLD-FUNCTIONS/tril.cc +++ b/src/DLD-FUNCTIONS/tril.cc @@ -347,7 +347,7 @@ @deftypefnx {Function File} {} triu (@var{a})\n\ @deftypefnx {Function File} {} triu (@var{a}, @var{k})\n\ @deftypefnx {Function File} {} triu (@var{a}, @var{k}, @var{pack})\n\ -Return a new matrix formed by extracting extract the lower (@code{tril})\n\ +Return a new matrix formed by extracting the lower (@code{tril})\n\ or upper (@code{triu}) triangular part of the matrix @var{a}, and\n\ setting all other elements to zero. The second argument is optional,\n\ and specifies how many diagonals above or below the main diagonal should\n\
--- a/src/syscalls.cc +++ b/src/syscalls.cc @@ -1709,7 +1709,7 @@ @deftypefn {Built-in Function} {} O_APPEND ()\n\ Return the numerical value of the file status flag that may be\n\ returned by @code{fcntl} to indicate each write operation appends,\n\ -or that may be passed to @code{fcntl} to set the write mode to append.\\n\ +or that may be passed to @code{fcntl} to set the write mode to append.\n\ @seealso{fcntl, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\ @end deftypefn") {