Mercurial > hg > octave-lyh
diff scripts/optimization/optimget.m @ 8715:954b6f69f51d
doc fixes
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 10 Feb 2009 16:02:36 -0500 |
parents | e07e93c04080 |
children | eb63fbe60fab |
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