Mercurial > hg > octave-avbm
changeset 8715:954b6f69f51d
doc fixes
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 10 Feb 2009 16:02:36 -0500 |
parents | 1f0c3b2961d7 |
children | 80910b37d855 |
files | scripts/optimization/optimget.m scripts/strings/strchr.m src/DLD-FUNCTIONS/bsxfun.cc src/DLD-FUNCTIONS/cellfun.cc src/DLD-FUNCTIONS/typecast.cc src/utils.cc |
diffstat | 6 files changed, 8 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/optimization/optimget.m +++ b/scripts/optimization/optimget.m @@ -19,9 +19,9 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} optimget (@var{options}, @var{parname}) -## @deftypefn {Function File} {} optimget (@var{options}, @var{parname}, @var{default}) -## Used to retrieve a specific option from a structure created by -## @code{optimset}. If @var{parname} is not a field of the @var{options} +## @deftypefnx {Function File} {} optimget (@var{options}, @var{parname}, @var{default}) +## Return a specific option from a structure created by +## @code{optimset}. If @var{parname} is not a field of the @var{options} ## structure, return @var{default} if supplied, otherwise return an ## empty matrix. ## @end deftypefn
--- a/scripts/strings/strchr.m +++ b/scripts/strings/strchr.m @@ -28,6 +28,7 @@ ## This will be faster than using regexp in most cases. ## ## @seealso{find} +## @end deftypefn function varargout = strchr (str, chars, varargin) if (nargin < 2 || ! ischar (str) || ! ischar (chars))
--- a/src/DLD-FUNCTIONS/bsxfun.cc +++ b/src/DLD-FUNCTIONS/bsxfun.cc @@ -127,7 +127,7 @@ } DEFUN_DLD (bsxfun, args, , - " -*- texinfo -*-\n\ + "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} bsxfun (@var{f}, @var{a}, @var{b})\n\ Applies a binary function @var{f} element-wise to two matrix arguments\n\ @var{a} and @var{b}. The function @var{f} must be capable of accepting\n\
--- a/src/DLD-FUNCTIONS/cellfun.cc +++ b/src/DLD-FUNCTIONS/cellfun.cc @@ -40,7 +40,7 @@ #include "unwind-prot.h" DEFUN_DLD (cellfun, args, nargout, - " -*- texinfo -*-\n\ + "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} cellfun (@var{name}, @var{c})\n\ @deftypefnx {Loadable Function} {} cellfun (\"size\", @var{c}, @var{k})\n\ @deftypefnx {Loadable Function} {} cellfun (\"isclass\", @var{c}, @var{class})\n\
--- a/src/DLD-FUNCTIONS/typecast.cc +++ b/src/DLD-FUNCTIONS/typecast.cc @@ -129,7 +129,7 @@ } DEFUN_DLD (typecast, args, , - " -*- texinfo -*-\n\ + "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} typecast (@var{x}, @var{type})\n\ Convert from one datatype to another without changing the underlying\n\ data. The argument @var{type} defines the type of the return argument\n\
--- a/src/utils.cc +++ b/src/utils.cc @@ -803,7 +803,7 @@ match is performed at the end of each path element. For example, if\n\ @var{dir} is @code{\"foo/bar\"}, it matches the path element\n\ @code{\"/some/dir/foo/bar\"}, but not @code{\"/some/dir/foo/bar/baz\"}\n\ -or @code{\"/some/dir/allfoo/bar.\n\ +or @code{\"/some/dir/allfoo/bar\"}.\n\ @end deftypefn") { octave_value retval = std::string ();